FlowiseAI/Flowise

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

📚 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. 1Install Flowisenpm install -g flowise
2. 2Start Flowise npx flowise start
3. 3Open [http://localhost:3000](http://localhost:3000)

🐳 Docker

Docker Compose

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

Docker Image

1. 1Build the image locally: docker build --no-cache -t flowise .
2. 2Run image: docker run -d --name flowise -p 3000:3000 flowise
3. 3Stop image: 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 PNPMnpm i -g pnpm

Setup

1. 1Clone the repository: git clone https://github.com/FlowiseAI/Flowise.git
2. 2Go into repository folder: cd Flowise
3. 3Install all dependencies of all modules: pnpm install
4. 4Build all the code: pnpm build # 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: pnpm build
5. 5Start the app: pnpm start You can now access the app on [http://localhost:3000](http://localhost:3000)
6. 6For 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](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](https://docs.flowiseai.com/configuration/deployment/aws)
• [Azure](https://docs.flowiseai.com/configuration/deployment/azure)
• [Digital Ocean](https://docs.flowiseai.com/configuration/deployment/digital-ocean)
• [GCP](https://docs.flowiseai.com/configuration/deployment/gcp)
• [Alibaba Cloud](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Flowise社区版)
• - [Railway](https://docs.flowiseai.com/configuration/deployment/railway) [](https://railway.app/template/pn4G8S?referralCode=WVNPD9) - [Northflank](https://northflank.com/stacks/deploy-flowiseai) [](https://northflank.com/stacks/deploy-flowiseai) - [Render](https://docs.flowiseai.com/configuration/deployment/render) [](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) [](https://elest.io/open-source/flowiseai) - [Sealos](https://template.sealos.io/deploy?templateName=flowise) [](https://template.sealos.io/deploy?templateName=flowise) - [RepoCloud](https://repocloud.io/details/?app_id=29) [](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.