Flowise README

The project's README from github.com/FlowiseAI/Flowise. As one markdown file: README.md.

Release Notes Discord Twitter Follow GitHub star chart GitHub fork

English | 繁體中文 | 简体中文 | 日本語 | 한국어

Flowise has been archived. Refer to [Future of Flowise](https://github.com/FlowiseAI/Flowise/discussions/6727)

Build AI Agents, Visually

📚 Table of Contents

⚡Quick Start

Download and Install NodeJS >= 20.0.0

  1. Install Flowise

    npm install -g flowise
    
  2. Start Flowise

    npx flowise start
    
  3. Open http://localhost:3000

🐳 Docker

Docker Compose

  1. Clone the Flowise project
  2. Go to docker folder at the root of the project
  3. Copy .env.example file, paste it into the same location, and rename to .env file
  4. docker compose up -d
  5. Open http://localhost:3000
  6. You can bring the containers down by docker compose stop

Docker Image

  1. Build the image locally:

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

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

    docker stop flowise
    

👨‍💻 Developers

Flowise has 3 different modules in a single mono repository.

Prerequisite

Setup

  1. Clone the repository:

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

    cd Flowise
    
  3. Install all dependencies of all modules:

    pnpm install
    
  4. Build all the code:

    pnpm build
    
    Exit code 134 (JavaScript heap out of memory) If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:
    # macOS / Linux / Git Bash
    export NODE_OPTIONS="--max-old-space-size=4096"
    
    # Windows PowerShell
    $env:NODE_OPTIONS="--max-old-space-size=4096"
    
    # Windows CMD
    set NODE_OPTIONS=--max-old-space-size=4096
    

    Then run:

    pnpm build
    
  5. Start the app:

    pnpm start
    

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

  6. For development build:

    • 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 code changes will reload the app automatically on http://localhost:8080

🌱 Env Variables

Flowise supports different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more

📖 Documentation

You can view the Flowise Docs here

🌐 Self Host

Deploy Flowise self-hosted in your existing infrastructure, we support various deployments

☁️ Flowise Cloud

Get Started with Flowise Cloud.

🙋 Support

Feel free to ask any questions, raise problems, and request new features in Discussion.

🙌 Contributing

Thanks go to these awesome contributors



See Contributing Guide. Reach out to us at Discord if you have any questions or issues.

Star History Chart

📄 License

Source code in this repository is made available under the Apache License Version 2.0.

Flowise (FlowiseAI/Flowise)

Searching Database…

55.5K ·GitHub
archived
What is this?Flowise is a drag-and-drop visual builder for creating AI agents, chatbots, and LLM workflows (chains, RAG pipelines, multi-agent systems) without hand-coding every integration.
Is this a library to import, or a standalone app?It is a full self-hosted web application with a Node.js backend and a React frontend, not a code library; you run it as a service and assemble flows in the browser.
How do I get it running?Clone the repo, go to the docker folder, copy .env.example to .env, then run docker compose up -d and open the UI in your browser.
Is this project still maintained?No - this repository has been archived and the README points users to the 'Future of Flowise' for continued development, so expect no further updates here.
Where can I deploy it?You can self-host on AWS, Azure, GCP, Digital Ocean, Alibaba Cloud, Railway, Render, HuggingFace Spaces and others, or skip hosting entirely with Flowise Cloud.
Why was Flowise archived?The maintainers archived this repo and direct users to the 'Future of Flowise' for ongoing work, meaning this codebase is a legacy snapshot rather than the actively developed version.
What's inside the monorepo?Three packages: a Node.js server exposing the API, a React UI, and components with third-party node integrations, plus auto-generated Swagger API docs.
Can I use Flowise without hosting it myself?Yes - Flowise Cloud is a managed, hosted option you can sign up for instead of running your own server.
What does it integrate with for building agents?It builds on LangChain and connects to LLM providers like OpenAI, letting you wire up chatbots, RAG pipelines, and multi-agent workflows visually.
Creator
FlowiseAI
Size
81 MB
Stars
55.5K
Age
3y
Commits · 90 Days