Build Workflow-Centric AI applications

Monkeys is an open source tool for build workflow-centric AI applications.

Note: We are currently iterating rapidly, so backwards compatibility is not guaranteed until a stable version (1.0.0) is released.

Documentation

You can read the documentation here: https://inf-monkeys.github.io/docs/.

Architecture

Monkeys Consists of the following key components:

• Monkeys Server: The main entrypoint
• Conductor: A microservices orchestration engine.
• Tools: HTTP Service exposes stanard RESTFul API that meet Monkeys standards, can be writen in any languages, deployed anywhere.

Getting Started

👨‍💻 Developer

Prerequisites

• Node 18: This project requires node version at least 18.

• yarn: We use yarn as the Node Package Manager.

• Conductor(Optional): Conductor is a workflow orchestration engine, we recommand use Docker to run Conductor, with one command bellow:

  docker pull infmonkeys/conductor:1.0.0
  
  docker run --name conductor -p 8080:8080 -d infmonkeys/conductor:1.0.0

  You can verify whether conductor running corrctly by use the following command:

  curl http://localhost:8080/api

  If show something like this, it's working fine:

  {"timestamp":"2024-03-21T10:29:36.635+00:00","status":404,"error":"Not Found","path":"/api"}
  

  If you do not install conductor, you won't be able to use the Workflow feature, but others still works fine.

• Redis(Optional): We use inmemory cache as default, for test purpose, you can just skip this.

• Postgres/MySQL(Optional): We use sqlite as default storage engine, for test purpose, you can just skip this.

Backend

1. Clone the repo

   git clone https://github.com/inf-monkeys/monkeys.git

2. Go to monkeys folder

   cd monkeys

3. Install Node Modules

   yarn

4. Run the server:

   yarn start

Frontend

1. Go to ui folder

   cd ui

2. Install Node Modules

   yarn

3. Update .env

   cp .env.example .env

   Set SERVER_ENDPOINT to your local server, http://localhost:3000 for example.

4. Start UI

   yarn dev

That's all, you are ready to go!

🐳 Docker

Docker Compose

We provide a docker-compose yaml, check the docs.

Helm

We provide a helm chart, check the docs.

Tools

Awesome Monkey Tools

Here is a detailed list of existing awesome monkey tools: https://github.com/inf-monkeys/awesome-monkey-tools.

Write Your Own Monkey Tool

We provided detailed information on how to write your own monkey tool, it's as simple as writing standard RESTFul APIs. You can read more on this topic at Write your own tools

Configuration

See all configuration values here.

OpenAPI Documentation

After you start the project, you can visit the following OpenAPI documentations:

• http://localhost:3000/openapi/server/
• http://localhost:3000/openapi/tools/

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Contributors

How to Contribute

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request