github.com/FlowiseAI/Flowise @flowise-components@3.1.3 sqlite

English | 繁體中文 | 简体中文 | 日本語 | 한국어

Build AI Agents, Visually

📚 Table of Contents

• ⚡ Quick Start
• 🐳 Docker
• 👨‍💻 Developers
• 🌱 Env Variables
• 📖 Documentation
• 🌐 Self Host
• ☁️ Flowise Cloud
• 🙋 Support
• 🙌 Contributing
• 📄 License

⚡Quick Start

Download and Install NodeJS >= 20.0.0

1. Install Flowise bash npm install -g flowise

2. Start Flowise

   bash npx flowise start

3. Open http://localhost:3000

🐳 Docker

Docker Compose

1. Clone the Flowise project
2. Go to docker folder at the root of the project
3. Copy .env.example file, paste it into the same location, and rename to .env file
4. docker compose up -d
5. Open http://localhost:3000
6. You can bring the containers down by docker compose stop

Docker Image

1. Build the image locally:

   bash docker build --no-cache -t flowise .

2. Run image:

   bash docker run -d --name flowise -p 3000:3000 flowise

3. Stop image:

   bash docker stop flowise

👨‍💻 Developers

Flowise has 3 different modules in a single mono repository.

• server: Node backend to serve API logics
• ui: React frontend
• components: Third-party nodes integrations
• api-documentation: Auto-generated swagger-ui API docs from express

Prerequisite

• Install PNPM bash npm i -g pnpm

Setup

1. Clone the repository:

   bash git clone https://github.com/FlowiseAI/Flowise.git

2. Go into repository folder:

   bash cd Flowise

3. Install all dependencies of all modules:

   bash pnpm install

4. Build all the code:

   bash pnpm build

Exit code 134 (JavaScript heap out of memory)

If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:

```bash
# macOS / Linux / Git Bash
export NODE_OPTIONS="--max-old-space-size=4096"

# Windows PowerShell
$env:NODE_OPTIONS="--max-old-space-size=4096"

# Windows CMD
set NODE_OPTIONS=--max-old-space-size=4096
```

Then run:

```bash
pnpm build
```

1. Start the app:

   bash pnpm start

   You can now access the app on http://localhost:3000

2. For development build:

   • Create .env file and specify the VITE_PORT (refer to .env.example) in packages/ui
   • Create .env file and specify the PORT (refer to .env.example) in packages/server

   • Run:

     bash pnpm dev

   Any code changes will reload the app automatically on http://localhost:8080

🌱 Env Variables

Flowise supports different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more

📖 Documentation

You can view the Flowise Docs here

🌐 Self Host

Deploy Flowise self-hosted in your existing infrastructure, we support various deployments

• AWS
• Azure
• Digital Ocean
• GCP
• Alibaba Cloud

Others

-   [Railway](https://docs.flowiseai.com/configuration/deployment/railway)

    [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)

-   [Northflank](https://northflank.com/stacks/deploy-flowiseai)

    [![Deploy to Northflank](https://assets.northflank.com/deploy_to_northflank_smm_36700fb050.svg)](https://northflank.com/stacks/deploy-flowiseai)

-   [Render](https://docs.flowiseai.com/configuration/deployment/render)

    [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/configuration/deployment/render)

-   [HuggingFace Spaces](https://docs.flowiseai.com/configuration/deployment/hugging-face)

    <a href="https://huggingface.co/spaces/FlowiseAI/Flowise"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>

-   [Elestio](https://elest.io/open-source/flowiseai)

    [![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/flowiseai)

-   [Sealos](https://template.sealos.io/deploy?templateName=flowise)

    [![Deploy on Sealos](https://sealos.io/Deploy-on-Sealos.svg)](https://template.sealos.io/deploy?templateName=flowise)

-   [RepoCloud](https://repocloud.io/details/?app_id=29)

    [![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29)

☁️ Flowise Cloud

Get Started with Flowise Cloud.

🙋 Support

Feel free to ask any questions, raise problems, and request new features in Discussion.

🙌 Contributing

Thanks go to these awesome contributors

See Contributing Guide. Reach out to us at Discord if you have any questions or issues.

📄 License

Source code in this repository is made available under the Apache License Version 2.0.