Getting Started

Prerequisite

Latest NodeJS installed

⚑Quick Start

  1. Install Flowise

npm install -g flowise
  1. Start Flowise

npx flowise start

🐳 Docker

Docker Compose

  1. Go to docker folder at the root of the project

  2. Copy the .env.example file and paste it as another file named .env

  3. docker-compose up -d

  4. You can bring the containers down by docker-compose stop

Docker Image

  1. Build the image locally:

docker build --no-cache -t flowise .
  1. Run image:

docker run -d --name flowise -p 3000:3000 flowise
  1. 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: Integrations components

Prerequisite

Install PNPM

npm i -g pnpm

Setup

  1. Clone the repository

git clone https://github.com/FlowiseAI/Flowise.git
  1. Go into repository folder

cd Flowise
  1. Install all dependencies of all modules:

pnpm install
  1. Build all the code:

pnpm build
  1. Start the app:

pnpm start

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

  1. For development build:

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

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

pnpm dev

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

Watch an introduction & setup tutorial on Flowise, shoutout to Leon!

Last updated