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 newly created branch.
Go into repository folder
```
cd Flowise
```
Install all dependencies of all modules:
```
pnpm install
```
Build all the code:
```
pnpm build
```
Start the app on http://localhost:3000
```
pnpm start
```
For development:
- 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 changes made in
```
packages/ui
```
or
```
packages/server
```
will be reflected on http://localhost:8080

For changes made in
```
packages/components
```
, run
```
pnpm 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.
Commit code and submit Pull Request from forked branch pointing to Flowise main.

🌱 Env Variables

Flowise support different environment variables to configure your instance. You can specify the following variables in the

.env

file inside

packages/server

folder. Read more

Variable	Description	Type	Default
PORT	The HTTP port Flowise runs on	Number	3000
CORS_ORIGINS	The allowed origins for all cross-origin HTTP calls	String
IFRAME_ORIGINS	The allowed origins for iframe src embedding	String
FLOWISE_FILE_SIZE_LIMIT	Upload File Size Limit	String	50mb
DEBUG	Print logs from components	Boolean
LOG_PATH	Location where log files are stored	String	`your-path/Flowise/logs`
LOG_LEVEL	Different levels of logs	Enum String: `error` , `info` , `verbose` , `debug`	`info`
LOG_JSON_SPACES	Spaces to beautify JSON logs		2
TOOL_FUNCTION_BUILTIN_DEP	NodeJS built-in modules to be used for Custom Tool or Function	String
TOOL_FUNCTION_EXTERNAL_DEP	External modules to be used for Custom Tool or Function	String
ALLOW_BUILTIN_DEP	Allow project dependencies to be used for Custom Tool or Function	Boolean	false
DATABASE_TYPE	Type of database to store the flowise data	Enum String: `sqlite` , `mysql` , `postgres`	`sqlite`
DATABASE_PATH	Location where database is saved (When DATABASE_TYPE is sqlite)	String	`your-home-dir/.flowise`
DATABASE_HOST	Host URL or IP address (When DATABASE_TYPE is not sqlite)	String
DATABASE_PORT	Database port (When DATABASE_TYPE is not sqlite)	String
DATABASE_USER	Database username (When DATABASE_TYPE is not sqlite)	String
DATABASE_PASSWORD	Database password (When DATABASE_TYPE is not sqlite)	String
DATABASE_NAME	Database name (When DATABASE_TYPE is not sqlite)	String
DATABASE_SSL_KEY_BASE64	Database SSL client cert in base64 (takes priority over DATABASE_SSL)	Boolean	false
DATABASE_SSL	Database connection overssl (When DATABASE_TYPE is postgre)	Boolean	false
SECRETKEY_PATH	Location where encryption key (used to encrypt/decrypt credentials) is saved	String	`your-path/Flowise/packages/server`
FLOWISE_SECRETKEY_OVERWRITE	Encryption key to be used instead of the key stored in SECRETKEY_PATH	String
MODEL_LIST_CONFIG_JSON	File path to load list of models from your local config file	String	`/your_model_list_config_file_path`
STORAGE_TYPE	Type of storage for uploaded files. default is `local`	Enum String: `s3` , `local` , `gcs`	`local`
BLOB_STORAGE_PATH	Local folder path where uploaded files are stored when `STORAGE_TYPE` is `local`	String	`your-home-dir/.flowise/storage`
S3_STORAGE_BUCKET_NAME	Bucket name to hold the uploaded files when `STORAGE_TYPE` is `s3`	String
S3_STORAGE_ACCESS_KEY_ID	AWS Access Key	String
S3_STORAGE_SECRET_ACCESS_KEY	AWS Secret Key	String
S3_STORAGE_REGION	Region for S3 bucket	String
S3_ENDPOINT_URL	Custom Endpoint for S3	String
S3_FORCE_PATH_STYLE	Set this to true to force the request to use path-style addressing	Boolean	false
GOOGLE_CLOUD_STORAGE_PROJ_ID	The GCP project id for cloud storage & logging when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_STORAGE_CREDENTIAL	The credential key file path when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_STORAGE_BUCKET_NAME	Bucket name to hold the uploaded files when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_UNIFORM_BUCKET_ACCESS	Enable uniform bucket level access when `STORAGE_TYPE` is `gcs`	Boolean	true
SHOW_COMMUNITY_NODES	Show nodes created by community	Boolean
DISABLED_NODES	Hide nodes from UI (comma separated list of node names)	String
TRUST_PROXY	Configure proxy trust settings for proper IP detection. Values: 'true' (trust all), 'false' (disable), number (hop count), or Express proxy values (e.g., 'loopback', 'linklocal', 'uniquelocal', IP addresses). Learn More	Boolean/String/Number	true

You can also specify the env variables when using

npx

. For example:

npx flowise start --PORT=3000 --DEBUG=true

Not sure what to contribute? Some ideas:

Create new components from

packages/components

Update existing components such as extending functionality, fixing bugs

Add new chatflow ideas

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

Install PNPM. The project is configured to use pnpm v10.

npm i -g pnpm

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 newly created branch.

Go into repository folder

cd Flowise

Install all dependencies of all modules:

pnpm install

Build all the code:

pnpm build

Start the app on http://localhost:3000

pnpm start

For development:

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 changes made in

packages/ui

packages/server

will be reflected on http://localhost:8080

For changes made in

packages/components

, run

pnpm 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.

Commit code and submit Pull Request from forked branch pointing to Flowise main.

🌱 Env Variables

Flowise support different environment variables to configure your instance. You can specify the following variables in the

.env

packages/server

Variable	Description	Type	Default
PORT	The HTTP port Flowise runs on	Number	3000
CORS_ORIGINS	The allowed origins for all cross-origin HTTP calls	String
IFRAME_ORIGINS	The allowed origins for iframe src embedding	String
FLOWISE_FILE_SIZE_LIMIT	Upload File Size Limit	String	50mb
DEBUG	Print logs from components	Boolean
LOG_PATH	Location where log files are stored	String	`your-path/Flowise/logs`
LOG_LEVEL	Different levels of logs	Enum String: `error` , `info` , `verbose` , `debug`	`info`
LOG_JSON_SPACES	Spaces to beautify JSON logs		2
TOOL_FUNCTION_BUILTIN_DEP	NodeJS built-in modules to be used for Custom Tool or Function	String
TOOL_FUNCTION_EXTERNAL_DEP	External modules to be used for Custom Tool or Function	String
ALLOW_BUILTIN_DEP	Allow project dependencies to be used for Custom Tool or Function	Boolean	false
DATABASE_TYPE	Type of database to store the flowise data	Enum String: `sqlite` , `mysql` , `postgres`	`sqlite`
DATABASE_PATH	Location where database is saved (When DATABASE_TYPE is sqlite)	String	`your-home-dir/.flowise`
DATABASE_HOST	Host URL or IP address (When DATABASE_TYPE is not sqlite)	String
DATABASE_PORT	Database port (When DATABASE_TYPE is not sqlite)	String
DATABASE_USER	Database username (When DATABASE_TYPE is not sqlite)	String
DATABASE_PASSWORD	Database password (When DATABASE_TYPE is not sqlite)	String
DATABASE_NAME	Database name (When DATABASE_TYPE is not sqlite)	String
DATABASE_SSL_KEY_BASE64	Database SSL client cert in base64 (takes priority over DATABASE_SSL)	Boolean	false
DATABASE_SSL	Database connection overssl (When DATABASE_TYPE is postgre)	Boolean	false
SECRETKEY_PATH	Location where encryption key (used to encrypt/decrypt credentials) is saved	String	`your-path/Flowise/packages/server`
FLOWISE_SECRETKEY_OVERWRITE	Encryption key to be used instead of the key stored in SECRETKEY_PATH	String
MODEL_LIST_CONFIG_JSON	File path to load list of models from your local config file	String	`/your_model_list_config_file_path`
STORAGE_TYPE	Type of storage for uploaded files. default is `local`	Enum String: `s3` , `local` , `gcs`	`local`
BLOB_STORAGE_PATH	Local folder path where uploaded files are stored when `STORAGE_TYPE` is `local`	String	`your-home-dir/.flowise/storage`
S3_STORAGE_BUCKET_NAME	Bucket name to hold the uploaded files when `STORAGE_TYPE` is `s3`	String
S3_STORAGE_ACCESS_KEY_ID	AWS Access Key	String
S3_STORAGE_SECRET_ACCESS_KEY	AWS Secret Key	String
S3_STORAGE_REGION	Region for S3 bucket	String
S3_ENDPOINT_URL	Custom Endpoint for S3	String
S3_FORCE_PATH_STYLE	Set this to true to force the request to use path-style addressing	Boolean	false
GOOGLE_CLOUD_STORAGE_PROJ_ID	The GCP project id for cloud storage & logging when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_STORAGE_CREDENTIAL	The credential key file path when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_STORAGE_BUCKET_NAME	Bucket name to hold the uploaded files when `STORAGE_TYPE` is `gcs`	String
GOOGLE_CLOUD_UNIFORM_BUCKET_ACCESS	Enable uniform bucket level access when `STORAGE_TYPE` is `gcs`	Boolean	true
SHOW_COMMUNITY_NODES	Show nodes created by community	Boolean
DISABLED_NODES	Hide nodes from UI (comma separated list of node names)	String
TRUST_PROXY	Configure proxy trust settings for proper IP detection. Values: 'true' (trust all), 'false' (disable), number (hop count), or Express proxy values (e.g., 'loopback', 'linklocal', 'uniquelocal', IP addresses). Learn More	Boolean/String/Number	true

You can also specify the env variables when using

npx

npx flowise start --PORT=3000 --DEBUG=true

Contributing to Flowise

⭐ Star

🙋 Q&A

💡 Ideas

🐞 Report Bugs

👨‍💻 Contribute to Code

Developers

Prerequisite

Step by step

🌱 Env Variables

📖 Contribute to Docs

🏷️ Pull Request process

📜 Code of Conduct

Related Skills

<h1 align="center">

- Identify gaps

2. Apply Deepthink Protocol (reason about dependencies

Contributing to Flowise

⭐ Star

🙋 Q&A

💡 Ideas

🐞 Report Bugs

👨‍💻 Contribute to Code

Developers

Prerequisite

Step by step

🌱 Env Variables

📖 Contribute to Docs

🏷️ Pull Request process

📜 Code of Conduct