📚 Table of Contents

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

⚡Quick Start

Download and Install NodeJS >= 18.15.0

Install Flowise
```
npm install -g flowise
```
Start Flowise
```
npx flowise start
```
Open http://localhost:3000

🐳 Docker

Docker Compose

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

Docker Image

Build the image locally:
```
docker build --no-cache -t flowise .
```

Run image:

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

Stop 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 PNPM
```
npm i -g pnpm
```

Setup

Clone the repository:

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

Go into repository folder:
```
cd Flowise
```
Install all dependencies of all modules:
```
pnpm install
```

Build all the code:

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:

# 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

Start the app:
```
pnpm start
```
You can now access the app on http://localhost:3000
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:
```
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