Skip to content

FlowiseAI/Flowise

Repository files navigation

Flowise - Build LLM Apps Easily

Release Notes Discord Twitter Follow GitHub star chart GitHub fork

English |Tiếng Trung|Nhật Bản ngữ|한국어

Drag & drop UI to build your customized LLM flow

⚡Quick Start

Download and InstallNodeJS>= 18.15.0

  1. Install Flowise

    npm install -g flowise
  2. Start Flowise

    npx flowise start

    With username & password

    npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234
  3. Openhttp://localhost:3000

🐳 Docker

Docker Compose

  1. Clone the Flowise project
  2. Go todockerfolder at the root of the project
  3. Copy.env.examplefile, paste it into the same location, and rename to.env
  4. docker compose up -d
  5. Openhttp://localhost:3000
  6. You can bring the containers down bydocker 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.

  • server:Node backend to serve API logics
  • ui:React frontend
  • components:Third-party nodes integrations
  • api-documentation:Auto-generated swagger-ui API docs from express

Prerequisite

  • InstallPNPM
    npm i -g pnpm

Setup

  1. Clone the repository

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

    cdFlowise
  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:
    export NODE_OPTIONS= "--max-old-space-size=4096"
    pnpm build
    
  5. Start the app:

    pnpm start

    You can now access the app onhttp://localhost:3000

  6. For development build:

    • Create.envfile and specify theVITE_PORT(refer to.env.example) inpackages/ui

    • Create.envfile and specify thePORT(refer to.env.example) inpackages/server

    • Run

      pnpm dev

    Any code changes will reload the app automatically onhttp://localhost:8080

🔒 Authentication

To enable app level authentication, addFLOWISE_USERNAMEandFLOWISE_PASSWORDto the.envfile inpackages/server:

FLOWISE_USERNAME=user
FLOWISE_PASSWORD=1234

🌱 Env Variables

Flowise support different environment variables to configure your instance. You can specify the following variables in the.envfile insidepackages/serverfolder. Readmore

📖 Documentation

Flowise Docs

🌐 Self Host

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

☁️ Flowise Cloud

Get Started with Flowise Cloud

🙋 Support

Feel free to ask any questions, raise problems, and request new features indiscussion

🙌 Contributing

Thanks go to these awesome contributors

Seecontributing guide.Reach out to us atDiscordif you have any questions or issues. Star History Chart

📄 License

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