ContextQMD
Back to Flowise

README

README.md

latest7.5 KB
Original Source
<!-- markdownlint-disable MD030 --> <p align="center"> </p> <div align="center">

English | ็น้ซ”ไธญๆ–‡ | ็ฎ€ไฝ“ไธญๆ–‡ | ๆ—ฅๆœฌ่ชž | ํ•œ๊ตญ์–ด

</div> <h3>Build AI Agents, Visually</h3> <a href="https://github.com/FlowiseAI/Flowise"> </a>

๐Ÿ“š Table of Contents

โšกQuick Start

Download and Install NodeJS >= 18.15.0

  1. Install Flowise

    bash
    npm install -g flowise

  2. Start Flowise

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

    bash
    docker build --no-cache -t flowise .

  2. Run image:

    bash
    docker run -d --name flowise -p 3000:3000 flowise

  3. Stop image:

    bash
    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

  • Install PNPM
    bash
    npm i -g pnpm

Setup

  1. Clone the repository:

    bash
    git clone https://github.com/FlowiseAI/Flowise.git

  2. Go into repository folder:

    bash
    cd Flowise

  3. Install all dependencies of all modules:

    bash
    pnpm install

  4. Build all the code:

    bash
    pnpm build
    <details> <summary>Exit code 134 (JavaScript heap out of memory)</summary> If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:
    bash
    # 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:

    bash
    pnpm build
    </details>

  5. Start the app:

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

      bash
      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

<a href="https://github.com/FlowiseAI/Flowise/graphs/contributors"> </a>

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

๐Ÿ“„ License

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