Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/FlowiseAI/Flowise

Drag & drop UI to build your customized LLM flow
https://github.com/FlowiseAI/Flowise

artificial-intelligence chatbot chatgpt hacktoberfest javascript langchain large-language-models llamaindex low-code no-code openai rag react typescript workflow-automation

Last synced: over 1 year ago
JSON representation

Drag & drop UI to build your customized LLM flow

Awesome Lists containing this project

README 

          






# Flowise - Build LLM Apps Easily



[![Release Notes](https://img.shields.io/github/release/FlowiseAI/Flowise)](https://github.com/FlowiseAI/Flowise/releases)

[![Discord](https://img.shields.io/discord/1087698854775881778?label=Discord&logo=discord)](https://discord.gg/jbaHfsRVBW)

[![Twitter Follow](https://img.shields.io/twitter/follow/FlowiseAI?style=social)](https://twitter.com/FlowiseAI)

[![GitHub star chart](https://img.shields.io/github/stars/FlowiseAI/Flowise?style=social)](https://star-history.com/#FlowiseAI/Flowise)

[![GitHub fork](https://img.shields.io/github/forks/FlowiseAI/Flowise?style=social)](https://github.com/FlowiseAI/Flowise/fork)



English | [็น้ซ”ไธญๆ–‡](./i18n/README-TW.md) | [็ฐก้ซ”ไธญๆ–‡](./i18n/README-ZH.md) | [ๆ—ฅๆœฌ่ชž](./i18n/README-JA.md) | [ํ•œ๊ตญ์–ด](./i18n/README-KR.md)



Drag & drop UI to build your customized LLM flow







## โšกQuick Start



Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0



1. Install Flowise

    ```bash

    npm install -g flowise

    ```

2. Start Flowise



    ```bash

    npx flowise start

    ```



    With username & password



    ```bash

    npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234

    ```



3. Open [http://localhost:3000](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](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](https://pnpm.io/installation)

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

    ```



    

    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:



    ```bash

    pnpm start

    ```



    You can now access the app on [http://localhost:3000](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](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](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables)



## ๐Ÿ“– Documentation



[Flowise Docs](https://docs.flowiseai.com/)



## ๐ŸŒ Self Host



Deploy Flowise self-hosted in your existing infrastructure, we support various [deployments](https://docs.flowiseai.com/configuration/deployment)



-   [AWS](https://docs.flowiseai.com/configuration/deployment/aws)

-   [Azure](https://docs.flowiseai.com/configuration/deployment/azure)

-   [Digital Ocean](https://docs.flowiseai.com/configuration/deployment/digital-ocean)

-   [GCP](https://docs.flowiseai.com/configuration/deployment/gcp)

-   [Alibaba Cloud](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Flowise็คพๅŒบ็‰ˆ)

-   

      Others



    -   [Railway](https://docs.flowiseai.com/configuration/deployment/railway)



        [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)



    -   [Render](https://docs.flowiseai.com/configuration/deployment/render)



        [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/configuration/deployment/render)



    -   [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face)



        HuggingFace Spaces



    -   [Elestio](https://elest.io/open-source/flowiseai)



        [![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/flowiseai)



    -   [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)



        [![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)



    -   [RepoCloud](https://repocloud.io/details/?app_id=29)



        [![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29)



      



## โ˜๏ธ Flowise Cloud



[Get Started with Flowise Cloud](https://flowiseai.com/)



## ๐Ÿ™‹ Support



Feel free to ask any questions, raise problems, and request new features in [discussion](https://github.com/FlowiseAI/Flowise/discussions)



## ๐Ÿ™Œ Contributing



Thanks go to these awesome contributors










See [contributing guide](CONTRIBUTING.md). Reach out to us at [Discord](https://discord.gg/jbaHfsRVBW) if you have any questions or issues.

[![Star History Chart](https://api.star-history.com/svg?repos=FlowiseAI/Flowise&type=Timeline)](https://star-history.com/#FlowiseAI/Flowise&Date)



## ๐Ÿ“„ License



Source code in this repository is made available under the [Apache License Version 2.0](LICENSE.md).