Build AI Agents, Visually
Go to file
Octavian FlowiseAI d437a6fb11 Enable github workflow pnpm caching 2024-03-15 08:51:01 +01:00
.github Enable github workflow pnpm caching 2024-03-15 08:51:01 +01:00
.husky - Updated workflow and pre-commit to work with PNPM, modified package.json to preinstall PNPM only. 2023-11-23 13:33:52 -05:00
assets
docker Merge branch 'main' into FEATURE/Vision 2024-02-14 18:06:33 +08:00
images update README 2023-07-19 02:23:56 +01:00
packages Set embed versions to latest (#1957) 2024-03-15 12:08:16 +05:30
.dockerignore
.eslintignore - Missed a few files that needed to be .jsx 2023-11-23 18:34:19 -05:00
.eslintrc.js
.gitignore ignore all files inside logs folder 2023-07-03 23:07:31 +01:00
.npmrc add turbo, changes to make it work across docker, docker-compose, npx 2023-11-27 11:56:40 +00:00
.prettierignore
.prettierrc.js
CODE_OF_CONDUCT-ZH.md Update CODE_OF_CONDUCT-ZH.md 2023-08-01 11:30:01 +08:00
CODE_OF_CONDUCT.md My native language is Simplified Chinese, so the i18n process is divided into stages. Currently, the Readme file is being translated into Chinese, and later on, i18next and react-i18next will be used for multilingual support. 2023-07-27 17:21:39 +08:00
CONTRIBUTING-ZH.md Fix merge conflicts 2024-03-06 16:03:12 +05:30
CONTRIBUTING.md Fix merge conflicts 2024-03-06 16:03:12 +05:30
Dockerfile - updated docker file to build with pnpm 2023-11-23 19:08:14 -05:00
LICENSE.md remove restrictions 2024-01-04 23:57:36 +00:00
README-ZH.md Fix merge conflicts 2024-03-06 16:03:12 +05:30
README.md update pnpm wordings 2024-03-12 16:53:20 +08:00
artillery-load-test.yml Update artillery-load-test.yml 2024-01-18 15:21:01 +00:00
babel.config.js
package.json Fix faiss-node not building when using pnpm 2024-03-13 15:14:19 +05:30
pnpm-lock.yaml Set embed versions to latest (#1957) 2024-03-15 12:08:16 +05:30
pnpm-workspace.yaml - Updated .js files to .jsx on frontend. 2023-11-23 08:17:06 -05: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.