Build AI Agents, Visually
Go to file
Henry Heng d0354bb25c
Chore/update flowise embed version (#2722)
* update flowise-embed version on lock file

* add agent messages to share chatbot
2024-06-26 02:18:08 +01:00
.github feat(ci): enable `pnpm` caching in CI (#2530) 2024-06-04 02:57:07 +01:00
.husky
assets
docker Improvement - Reduce size of final docker image with multistage build (#2598) 2024-06-07 15:35:57 +01:00
i18n Chore/update flowise embed version (#2722) 2024-06-26 02:18:08 +01:00
images
packages Chore/update flowise embed version (#2722) 2024-06-26 02:18:08 +01:00
.dockerignore Avoid .env packaging into docker images. (#2451) 2024-05-20 17:09:27 +01:00
.eslintrc.js
.gitignore Adding pnpm-store to gitignore (#2600) 2024-06-11 16:29:28 +01:00
.npmrc add turbo, changes to make it work across docker, docker-compose, npx 2023-11-27 11:56:40 +00:00
CODE_OF_CONDUCT.md Chore/update flowise embed version (#2722) 2024-06-26 02:18:08 +01:00
CONTRIBUTING.md Chore/update flowise embed version (#2722) 2024-06-26 02:18:08 +01:00
Dockerfile Chore/update docker node version 20 (#2271) 2024-04-26 14:52:08 +01:00
LICENSE.md remove restrictions 2024-01-04 23:57:36 +00:00
README.md gh: refactor community files (#2572) 2024-06-07 15:49:24 +01:00
artillery-load-test.yml Update artillery-load-test.yml 2024-01-18 15:21:01 +00:00
package.json chore: move configurations to `package.json` (#2613) 2024-06-21 22:13:13 +01:00
pnpm-lock.yaml Chore/update flowise embed version (#2722) 2024-06-26 02:18:08 +01:00
pnpm-workspace.yaml Feature/Mistral FunctionAgent (#1912) 2024-03-18 13:17:00 +08:00
turbo.json add turbo, changes to make it work across docker, docker-compose, npx 2023-11-27 11:56:40 +00:00

README.md

Flowise - Build LLM Apps Easily

Release Notes Discord Twitter Follow GitHub star chart GitHub fork

English | 中文 | 日本語 | 한국어

Drag & drop UI to build your customized LLM flow

Quick Start

Download and Install NodeJS >= 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. Open http://localhost:3000

🐳 Docker

Docker Compose

  1. Go to docker folder at the root of the project
  2. Copy .env.example file, paste it into the same location, and rename to .env
  3. docker-compose up -d
  4. Open http://localhost:3000
  5. 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.

  • server: Node backend to serve API logics
  • ui: React frontend
  • components: Third-party nodes integrations

Prerequisite

  • Install PNPM
    npm i -g pnpm
    

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

🔒 Authentication

To enable app level authentication, add FLOWISE_USERNAME and FLOWISE_PASSWORD to the .env file in packages/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 .env file inside packages/server folder. Read more

📖 Documentation

Flowise Docs

🌐 Self Host

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

💻 Cloud Hosted

Coming soon

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