Skip to content

Latest commit

 

History

History
193 lines (123 loc) · 5.46 KB

README.md

File metadata and controls

193 lines (123 loc) · 5.46 KB

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: Langchain components

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:

    yarn install
  4. Build all the code:

    yarn build
  5. Start the app:

    yarn start

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

  6. For development build:

    • Create .env file and specify the PORT (refer to .env.example) in packages/ui

    • Create .env file and specify the PORT (refer to .env.example) in packages/server

    • Run

      yarn 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 on Railway

Deploy to Render

Deploy

HuggingFace Spaces

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