203 lines
6.6 KiB
Markdown
203 lines
6.6 KiB
Markdown
<!-- markdownlint-disable MD030 -->
|
||
|
||
<p align="center">
|
||
<img src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_white.svg#gh-light-mode-only">
|
||
<img src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise_dark.svg#gh-dark-mode-only">
|
||
</p>
|
||
|
||
[](https://github.com/FlowiseAI/Flowise/releases)
|
||
[](https://discord.gg/jbaHfsRVBW)
|
||
[](https://twitter.com/FlowiseAI)
|
||
[](https://star-history.com/#FlowiseAI/Flowise)
|
||
[](https://github.com/FlowiseAI/Flowise/fork)
|
||
|
||
[English](../README.md) | 繁體中文 | [简体中文](./README-ZH.md) | [日本語](./README-JA.md) | [한국어](./README-KR.md)
|
||
|
||
<h3>可視化建構 AI/LLM 流程</h3>
|
||
<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>
|
||
|
||
## ⚡ 快速開始
|
||
|
||
下載並安裝 [NodeJS](https://nodejs.org/en/download) >= 18.15.0
|
||
|
||
1. 安裝 Flowise
|
||
```bash
|
||
npm install -g flowise
|
||
```
|
||
2. 啟動 Flowise
|
||
|
||
```bash
|
||
npx flowise start
|
||
```
|
||
|
||
3. 打開 [http://localhost:3000](http://localhost:3000)
|
||
|
||
## 🐳 Docker
|
||
|
||
### Docker Compose
|
||
|
||
1. 克隆 Flowise 項目
|
||
2. 進入項目根目錄的 `docker` 文件夾
|
||
3. 複製 `.env.example` 文件,粘貼到相同位置,並重命名為 `.env` 文件
|
||
4. `docker compose up -d`
|
||
5. 打開 [http://localhost:3000](http://localhost:3000)
|
||
6. 您可以通過 `docker compose stop` 停止容器
|
||
|
||
### Docker 映像
|
||
|
||
1. 本地構建映像:
|
||
```bash
|
||
docker build --no-cache -t flowise .
|
||
```
|
||
2. 運行映像:
|
||
|
||
```bash
|
||
docker run -d --name flowise -p 3000:3000 flowise
|
||
```
|
||
|
||
3. 停止映像:
|
||
```bash
|
||
docker stop flowise
|
||
```
|
||
|
||
## 👨💻 開發者
|
||
|
||
Flowise 在單個 mono 存儲庫中有 3 個不同的模塊。
|
||
|
||
- `server`: 提供 API 邏輯的 Node 後端
|
||
- `ui`: React 前端
|
||
- `components`: 第三方節點集成
|
||
- `api-documentation`: 從 express 自動生成的 swagger-ui API 文檔
|
||
|
||
### 先決條件
|
||
|
||
- 安裝 [PNPM](https://pnpm.io/installation)
|
||
```bash
|
||
npm i -g pnpm
|
||
```
|
||
|
||
### 設置
|
||
|
||
1. 克隆存儲庫
|
||
|
||
```bash
|
||
git clone https://github.com/FlowiseAI/Flowise.git
|
||
```
|
||
|
||
2. 進入存儲庫文件夾
|
||
|
||
```bash
|
||
cd Flowise
|
||
```
|
||
|
||
3. 安裝所有模塊的所有依賴項:
|
||
|
||
```bash
|
||
pnpm install
|
||
```
|
||
|
||
4. 構建所有代碼:
|
||
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
<details>
|
||
<summary>退出代碼 134(JavaScript 堆內存不足)</summary>
|
||
如果在運行上述 `build` 腳本時遇到此錯誤,請嘗試增加 Node.js 堆大小並重新運行腳本:
|
||
|
||
export NODE_OPTIONS="--max-old-space-size=4096"
|
||
pnpm build
|
||
|
||
</details>
|
||
|
||
5. 啟動應用:
|
||
|
||
```bash
|
||
pnpm start
|
||
```
|
||
|
||
您現在可以訪問 [http://localhost:3000](http://localhost:3000)
|
||
|
||
6. 對於開發構建:
|
||
|
||
- 在 `packages/ui` 中創建 `.env` 文件並指定 `VITE_PORT`(參考 `.env.example`)
|
||
- 在 `packages/server` 中創建 `.env` 文件並指定 `PORT`(參考 `.env.example`)
|
||
- 運行
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
任何代碼更改都會自動重新加載應用程序 [http://localhost:8080](http://localhost:8080)
|
||
|
||
## 🌱 環境變量
|
||
|
||
Flowise 支持不同的環境變量來配置您的實例。您可以在 `packages/server` 文件夾中的 `.env` 文件中指定以下變量。閱讀 [更多](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables)
|
||
|
||
## 📖 文檔
|
||
|
||
[Flowise 文檔](https://docs.flowiseai.com/)
|
||
|
||
## 🌐 自我托管
|
||
|
||
在您現有的基礎設施中部署 Flowise 自我托管,我們支持各種 [部署](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)
|
||
- [阿里雲](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Flowise社区版)
|
||
- <details>
|
||
<summary>其他</summary>
|
||
|
||
- [Railway](https://docs.flowiseai.com/configuration/deployment/railway)
|
||
|
||
[](https://railway.app/template/pn4G8S?referralCode=WVNPD9)
|
||
|
||
- [Render](https://docs.flowiseai.com/configuration/deployment/render)
|
||
|
||
[](https://docs.flowiseai.com/configuration/deployment/render)
|
||
|
||
- [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face)
|
||
|
||
<a href="https://huggingface.co/spaces/FlowiseAI/Flowise"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>
|
||
|
||
- [Elestio](https://elest.io/open-source/flowiseai)
|
||
|
||
[](https://elest.io/open-source/flowiseai)
|
||
|
||
- [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
|
||
|
||
[](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
|
||
|
||
- [RepoCloud](https://repocloud.io/details/?app_id=29)
|
||
|
||
[](https://repocloud.io/details/?app_id=29)
|
||
|
||
</details>
|
||
|
||
## ☁️ Flowise 雲
|
||
|
||
[開始使用 Flowise 雲](https://flowiseai.com/)
|
||
|
||
## 🙋 支持
|
||
|
||
隨時在 [討論](https://github.com/FlowiseAI/Flowise/discussions) 中提出任何問題、提出問題和請求新功能
|
||
|
||
## 🙌 貢獻
|
||
|
||
感謝這些出色的貢獻者
|
||
|
||
<a href="https://github.com/FlowiseAI/Flowise/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=FlowiseAI/Flowise" />
|
||
</a>
|
||
|
||
請參閱 [貢獻指南](CONTRIBUTING.md)。如果您有任何問題或問題,請通過 [Discord](https://discord.gg/jbaHfsRVBW) 與我們聯繫。
|
||
[](https://star-history.com/#FlowiseAI/Flowise&Date)
|
||
|
||
## 📄 許可證
|
||
|
||
此存儲庫中的源代碼根據 [Apache 許可證版本 2.0](LICENSE.md) 提供。
|