Get Started
Cloud
Self-hosting requires more technical skill to setup instance, backing up database and maintaning updates. If you aren't experienced at managing servers and just want to use the webapp, we recommend using Flowise Cloud.
Quick Start
Pre-requisite: ensure NodeJS is installed on machine. Node v18.15.0
or v20
and above is supported.
Install Flowise locally using NPM.
Install Flowise:
Start Flowise:
Open: http://localhost:3000
Docker
There are two ways to deploy Flowise with Docker:
Docker Compose
Go to
docker folder
at the root of the projectCopy the
.env.example
file and paste it as another file named.env
Run:
Open: http://localhost:3000
You can bring the containers down by running:
Docker Image
Build the image:
Run image:
Stop image:
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.
Setup 1
Simple setup using PNPM:
Clone the repository
Go into repository folder
Install all dependencies of all modules:
Build the code:
Start the app at http://localhost:3000
Setup 2
Step-by-step setup for project contributors:
Fork the official Flowise Github Repository
Clone your forked repository
Create a new branch, see guide. Naming conventions:
For feature branch:
feature/<Your New Feature>
For bug fix branch:
bugfix/<Your New Bugfix>
.
Switch to the branch you just created
Go into repository folder:
Install all dependencies of all modules:
Build the code:
Start the app at http://localhost:3000
For development build:
Create
.env
file and specify thePORT
(refer to.env.example
) inpackages/ui
Create
.env
file and specify thePORT
(refer to.env.example
) inpackages/server
Any changes made in
packages/ui
orpackages/server
will be reflected at http://localhost:8080For changes made in
packages/components
, you will need to build again to pickup the changesAfter making all the changes, run:
and
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.
Community Guide
Last updated