Skip to main content
We appreciate any form of contributions to Flowise. Whether you’re fixing bugs, adding features, or sharing your chatflows, your contributions help make Flowise better for everyone.

​
Ways to Contribute

​
Star the Repository

Star and share the GitHub Repository to help increase visibility and support the project.

​
Ask Questions

Search for questions in the Q&A section. If you can’t find an answer, create a new discussion. Your question might help others with similar issues.

​
Share Your Chatflows

Export your chatflow as JSON, attach a screenshot, and share it in the Show and Tell section.

​
Submit Ideas

Have ideas for new features, app integrations, or improvements? Submit them in the Ideas section.

​
Report Bugs

Found an issue? Report it on GitHub with detailed information to help us reproduce and fix it.

​
Contributing Code

​
What to Contribute

Not sure where to start? Here are some ideas:
  • Create new components in packages/components
  • Update existing components with new functionality or bug fixes
  • Add new chatflow templates and examples
  • Improve documentation

​
Project Structure

Flowise is organized as a monorepo with three main modules:

Server

Node.js backend serving API logic

UI

React frontend application

Components

Third-party node integrations

​
Development Setup

1

Prerequisites

Install PNPM version 10:
npm i -g pnpm
2

Fork and Clone

  1. Fork the Flowise repository
  2. Clone your forked repository:
git clone https://github.com/YOUR_USERNAME/Flowise.git
cd Flowise
3

Create a Branch

Create a new branch following the naming conventions:
git checkout -b feature/your-new-feature
4

Install Dependencies

pnpm install
5

Build the Code

pnpm build
If you encounter “JavaScript heap out of memory” errors, increase Node.js heap size:
# macOS / Linux / Git Bash
export NODE_OPTIONS="--max-old-space-size=4096"

# Windows PowerShell
$env:NODE_OPTIONS="--max-old-space-size=4096"
6

Start Development

For production mode:
pnpm start
Access the app at http://localhost:3000For development mode with hot reload:
  1. Create .env file in packages/ui (refer to .env.example)
  2. Create .env file in packages/server (refer to .env.example)
  3. Run:
pnpm dev
Access the app at http://localhost:8080
Changes in packages/ui and packages/server will reload automatically. For changes in packages/components, run pnpm build again.
7

Test Your Changes

Before submitting, ensure everything works in production:
pnpm build
pnpm start
8

Submit Pull Request

Commit your changes and submit a pull request from your branch to Flowise main.

​
Environment Variables

Flowise supports various environment variables for configuration. Specify them in the .env file inside packages/server folder.
For a complete list of environment variables, see the Environment Variables documentation.

​
Contributing to Documentation

Documentation contributions are managed in the Flowise Docs repository.

​
Pull Request Process

1

Review

A FlowiseAI team member will be automatically notified when you open a pull request.
2

Discussion

The team may request changes or ask questions about your contribution.
3

Merge

Once approved, your pull request will be merged into the main branch.
Need help with your pull request? Reach out on Discord.

​
Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code. Report unacceptable behavior to [email protected].

​
Our Standards

Positive behaviors include:
  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what’s best for the community
  • Showing empathy towards other community members
Unacceptable behaviors include:
  • Sexualized language or imagery and unwelcome sexual attention
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others’ private information without permission
  • Other conduct inappropriate in a professional setting

​
Get Help

Discord Community

Join our Discord server for real-time help and discussions

GitHub Discussions

Browse or start discussions on GitHub

Build docs developers (and LLMs) love

Get started for freeTalk to us