mirror of
https://github.com/farcasclaudiu/Flowise.git
synced 2026-06-28 19:00:59 +03:00
Update README.md (#4870)
* Update README.md Enhanced the readability of file file and fixed minor grammatical errors * Update README.md Added proper spacing and fixed few minor erros
This commit is contained in:
@@ -5,6 +5,8 @@
|
|||||||
<img src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_dark.svg#gh-dark-mode-only">
|
<img src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_dark.svg#gh-dark-mode-only">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
[](https://github.com/FlowiseAI/Flowise/releases)
|
[](https://github.com/FlowiseAI/Flowise/releases)
|
||||||
[](https://discord.gg/jbaHfsRVBW)
|
[](https://discord.gg/jbaHfsRVBW)
|
||||||
[](https://twitter.com/FlowiseAI)
|
[](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)
|
English | [繁體中文](./i18n/README-TW.md) | [简体中文](./i18n/README-ZH.md) | [日本語](./i18n/README-JA.md) | [한국어](./i18n/README-KR.md)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<h3>Build AI Agents, Visually</h3>
|
<h3>Build AI Agents, Visually</h3>
|
||||||
<a href="https://github.com/FlowiseAI/Flowise">
|
<a href="https://github.com/FlowiseAI/Flowise">
|
||||||
<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_agentflow.gif?raw=true"></a>
|
<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_agentflow.gif?raw=true"></a>
|
||||||
|
|
||||||
|
## 📚 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
|
## ⚡Quick Start
|
||||||
|
|
||||||
Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0
|
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
|
### Docker Image
|
||||||
|
|
||||||
1. Build the image locally:
|
1. Build the image locally:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build --no-cache -t flowise .
|
docker build --no-cache -t flowise .
|
||||||
```
|
```
|
||||||
2. Run image:
|
2. Run image:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d --name flowise -p 3000:3000 flowise
|
docker run -d --name flowise -p 3000:3000 flowise
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Stop image:
|
3. Stop image:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker stop flowise
|
docker stop flowise
|
||||||
```
|
```
|
||||||
@@ -79,13 +98,13 @@ Flowise has 3 different modules in a single mono repository.
|
|||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/FlowiseAI/Flowise.git
|
git clone https://github.com/FlowiseAI/Flowise.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Go into repository folder
|
2. Go into repository folder:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd Flowise
|
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 `VITE_PORT` (refer to `.env.example`) in `packages/ui`
|
||||||
- Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server`
|
- Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server`
|
||||||
- Run
|
- Run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm dev
|
pnpm dev
|
||||||
@@ -134,11 +153,11 @@ Flowise has 3 different modules in a single mono repository.
|
|||||||
|
|
||||||
## 🌱 Env Variables
|
## 🌱 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
|
## 📖 Documentation
|
||||||
|
|
||||||
[Flowise Docs](https://docs.flowiseai.com/)
|
You can view the Flowise Docs [here](https://docs.flowiseai.com/)
|
||||||
|
|
||||||
## 🌐 Self Host
|
## 🌐 Self Host
|
||||||
|
|
||||||
@@ -180,11 +199,11 @@ Deploy Flowise self-hosted in your existing infrastructure, we support various [
|
|||||||
|
|
||||||
## ☁️ Flowise Cloud
|
## ☁️ Flowise Cloud
|
||||||
|
|
||||||
[Get Started with Flowise Cloud](https://flowiseai.com/)
|
Get Started with [Flowise Cloud](https://flowiseai.com/).
|
||||||
|
|
||||||
## 🙋 Support
|
## 🙋 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
|
## 🙌 Contributing
|
||||||
|
|
||||||
@@ -192,9 +211,10 @@ Thanks go to these awesome contributors
|
|||||||
|
|
||||||
<a href="https://github.com/FlowiseAI/Flowise/graphs/contributors">
|
<a href="https://github.com/FlowiseAI/Flowise/graphs/contributors">
|
||||||
<img src="https://contrib.rocks/image?repo=FlowiseAI/Flowise" />
|
<img src="https://contrib.rocks/image?repo=FlowiseAI/Flowise" />
|
||||||
</a>
|
</a><br><br>
|
||||||
|
|
||||||
|
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.
|
|
||||||
[](https://star-history.com/#FlowiseAI/Flowise&Date)
|
[](https://star-history.com/#FlowiseAI/Flowise&Date)
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|||||||
Reference in New Issue
Block a user