Get Started

Learn how to deploy Flowise locally


Before you can get started, you'll need to ensure that you have the NodeJS installed on your computer. Node v18.15.0 or v20 and above is supported.

Quick Start

Install Flowise locally using NPM.

  1. Install Flowise:

npm install -g flowise
  1. Start Flowise:

npx flowise start

Docker

There are two ways to deploy Flowise with 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. Run:

docker-compose up -d
  1. You can bring the containers down by running:

docker-compose stop

Docker Image

  1. Build the image:

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

docker run -d --name flowise -p 3000:3000 flowise
  1. Stop image:

docker stop flowise

For Developers

Flowise has 3 different modules in a single mono repository:

  • Server: Node backend to serve API logics

  • UI: React frontend

  • Components: Integration components

Prerequisite

Install PNPM.

npm i -g pnpm

Setup 1

Simple setup using PNPM:

  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 the code:

pnpm build

Start the app at http://localhost:3000

pnpm start

Setup 2

Step-by-step setup for project contributors:

  1. Fork the official Flowise Github Repository

  2. Clone your forked repository

  3. Create a new branch, see guide. Naming conventions:

    • For feature branch: feature/<Your New Feature>

    • For bug fix branch: bugfix/<Your New Bugfix>.

  4. Switch to the branch you just created

  5. Go into repository folder:

cd Flowise
  1. Install all dependencies of all modules:

pnpm install
  1. Build the code:

pnpm build
  1. Start the app at http://localhost:3000

pnpm start
  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 changes made in packages/ui or packages/server will be reflected at http://localhost:8080

  • For changes made in packages/components, you will need to build again to pickup the changes

  • After making all the changes, run:

    pnpm build

    and

    pnpm start

    to make sure everything works fine in production.


Learn More

In this video tutorial, Leon provides an introduction to Flowise and explains how to set it up on your local machine.

Last updated