diff --git a/README.md b/README.md index cd994bdc..8fc74205 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@

+
+ [![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) @@ -13,10 +15,25 @@ English | [繁體中文](./i18n/README-TW.md) | [简体中文](./i18n/README-ZH.md) | [日本語](./i18n/README-JA.md) | [한국어](./i18n/README-KR.md) +
+

Build AI Agents, Visually

+## 📚 Table of Contents + +- [⚡ Quick Start](#-quick-start) +- [🐳 Docker](#-docker) +- [👨‍💻 Developers](#-developers) +- [🌱 Env Variables](#-env-variables) +- [📖 Documentation](#-documentation) +- [🌐 Self Host](#-self-host) +- [☁️ Flowise Cloud](#️-flowise-cloud) +- [🙋 Support](#-support) +- [🙌 Contributing](#-contributing) +- [📄 License](#-license) + ## ⚡Quick Start Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0 @@ -47,16 +64,18 @@ Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0 ### 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 ``` @@ -79,13 +98,13 @@ Flowise has 3 different modules in a single mono repository. ### Setup -1. Clone the repository +1. Clone the repository: ```bash git clone https://github.com/FlowiseAI/Flowise.git ``` -2. Go into repository folder +2. Go into repository folder: ```bash cd Flowise @@ -124,7 +143,7 @@ Flowise has 3 different modules in a single mono repository. - 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 + - Run: ```bash pnpm dev @@ -134,11 +153,11 @@ Flowise has 3 different modules in a single mono repository. ## 🌱 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) +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](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables) ## 📖 Documentation -[Flowise Docs](https://docs.flowiseai.com/) +You can view the Flowise Docs [here](https://docs.flowiseai.com/) ## 🌐 Self Host @@ -180,11 +199,11 @@ Deploy Flowise self-hosted in your existing infrastructure, we support various [ ## ☁️ Flowise Cloud -[Get Started with Flowise Cloud](https://flowiseai.com/) +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) +Feel free to ask any questions, raise problems, and request new features in [Discussion](https://github.com/FlowiseAI/Flowise/discussions). ## 🙌 Contributing @@ -192,9 +211,10 @@ 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. -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