Sultan
/
Flowise
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #627 from xiexin12138/feature/i18n 

Translate the Readme file into Simplified Chinese
This commit is contained in:
Henry Heng 2023-08-01 01:38:32 +01:00 committed by GitHub
parent ef6125ec24 3e87aba9c5
commit 7a3a5fe367
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 540 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
CODE_OF_CONDUCT-ZH.md Normal file
View File

@ -0,0 +1,49 @@
<!-- markdownlint-disable MD030 -->
# 贡献者公约行为准则
[English](<./CODE_OF_CONDUCT.md>) | 中文
## 我们的承诺
为了促进一个开放和友好的环境，我们作为贡献者和维护者承诺，使参与我们的项目和社区的体验对每个人来说都是无骚扰的，无论年龄、体型、残疾、种族、性别认同和表达、经验水平、国籍、个人形象、种族、宗教或性取向如何。
## 我们的标准
有助于创建积极环境的行为示例包括：
- 使用友好和包容性的语言
- 尊重不同的观点和经验
- 优雅地接受建设性的批评
- 关注社区最有利的事情
- 向其他社区成员表达同理心
参与者不可接受的行为示例包括：
- 使用性暗示的语言或图像和不受欢迎的性关注或进展
- 恶作剧、侮辱/贬低的评论和个人或政治攻击
- 公开或私下骚扰
- 未经明确许可发布他人的私人信息，如实际或电子地址
- 在专业环境中可能被合理认为不适当的其他行为
## 我们的责任
项目维护者有责任明确可接受行为的标准，并预期对任何不可接受行为的情况采取适当和公正的纠正措施。
项目维护者有权和责任删除、编辑或拒绝不符合本行为准则的评论、提交、代码、维基编辑、问题和其他贡献，或者临时或永久禁止任何贡献者，如果他们认为其行为不适当、威胁、冒犯或有害。
## 适用范围
本行为准则适用于项目空间和公共空间，当个人代表项目或其社区时。代表项目或社区的示例包括使用官方项目电子邮件地址、通过官方社交媒体账号发布或在线或离线活动中担任指定代表。项目的代表可以由项目维护者进一步定义和澄清。
## 执法
可以通过联系项目团队 hello@flowiseai.com 来报告滥用、骚扰或其他不可接受的行为。所有投诉将经过审核和调查，并将得出视情况认为必要和适当的回应。项目团队有义务对事件举报人保持机密。具体执行政策的更多细节可能会单独发布。
如果项目维护者不诚信地遵守或执行行为准则，可能会面临其他项目领导成员决定的临时或永久的后果。
## 归属
本行为准则改编自[贡献者公约][主页]，版本1.4，可在[http://contributor-covenant.org/version/1/4][版本]上获取。
[主页]: http://contributor-covenant.org

2
CODE_OF_CONDUCT.md
View File

@ -1,5 +1,7 @@
# Contributor Covenant Code of Conduct # Contributor Covenant Code of Conduct
English | [中文](<./CODE_OF_CONDUCT-ZH.md>)
## Our Pledge ## Our Pledge
In the interest of fostering an open and welcoming environment, we as In the interest of fostering an open and welcoming environment, we as

156
CONTRIBUTING-ZH.md Normal file
View File

@ -0,0 +1,156 @@
<!-- markdownlint-disable MD030 -->
# 贡献给Flowise
[English](<./CONTRIBUTING.md>) | 中文
我们欢迎任何形式的贡献。
## ⭐ 点赞
点赞并分享[Github仓库](https://github.com/FlowiseAI/Flowise)。
## 🙋 问题和回答
在[问题和回答](https://github.com/FlowiseAI/Flowise/discussions/categories/q-a)部分搜索任何问题，如果找不到，可以毫不犹豫地创建一个。这可能会帮助到其他有类似问题的人。
## 🙌 分享Chatflow
是的！分享你如何使用Flowise是一种贡献方式。将你的Chatflow导出为JSON，附上截图并在[展示和分享](https://github.com/FlowiseAI/Flowise/discussions/categories/show-and-tell)部分分享。
## 💡 想法
欢迎各种想法，如新功能、应用集成和区块链网络。在[想法](https://github.com/FlowiseAI/Flowise/discussions/categories/ideas)部分提交。
## 🐞 报告错误
发现问题了吗？[报告它](https://github.com/FlowiseAI/Flowise/issues/new/choose)。
## 👨‍💻 贡献代码
不确定要贡献什么？一些想法：
- 从Langchain创建新组件
- 更新现有组件，如扩展功能、修复错误
- 添加新的Chatflow想法
### 开发人员
Flowise在一个单一的单体存储库中有3个不同的模块。
- `server`：用于提供API逻辑的Node后端
- `ui`：React前端
- `components`：Langchain组件
#### 先决条件
- 安装 [Yarn v1](https://classic.yarnpkg.com/en/docs/install)
```bash
npm i -g yarn
```
#### 逐步指南
1. Fork官方的[Flowise Github 仓库](https://github.com/FlowiseAI/Flowise)。
2. 克隆你fork的存储库。
3. 创建一个新的分支，参考[指南](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)。命名约定：
- 对于功能分支：`feature/<你的新功能>`
- 对于bug修复分支：`bugfix/<你的新bug修复>`。
4. 切换到新创建的分支。
5. 进入存储库文件夹
```bash
cd Flowise
```
6. 安装所有模块的依赖项：
```bash
yarn install
```
7. 构建所有代码：
```bash
yarn build
```
8. 在[http://localhost:3000](http://localhost:3000)上启动应用程序
```bash
yarn start
```
9. 开发时：
- 在`packages/ui`中创建`.env`文件并指定`PORT`（参考`.env.example`）
- 在`packages/server`中创建`.env`文件并指定`PORT`（参考`.env.example`）
- 运行
```bash
yarn dev
```
对`packages/ui`或`packages/server`进行的任何更改都将反映在[http://localhost:8080](http://localhost:8080)上
对于`packages/components`中进行的更改，再次运行`yarn build`以应用更改。
10. 做完所有的更改后，运行以下命令来确保在生产环境中一切正常：
```bash
yarn build
```
和
```bash
yarn start
```
11. 提交代码并从指向 [Flowise 主分支](https://github.com/FlowiseAI/Flowise/tree/master) 的分叉分支上提交 Pull Request。
## 🌱 环境变量
Flowise 支持不同的环境变量来配置您的实例。您可以在 `packages/server` 文件夹中的 `.env` 文件中指定以下变量。阅读[更多信息](https://docs.flowiseai.com/environment-variables)
| 变量名 | 描述 | 类型 | 默认值 |
| -------------------------- | ------------------------------------------------------------ | ------------------------------------------------- | ----------------------------------- |
| PORT | Flowise 运行的 HTTP 端口 | 数字 | 3000 |
| FLOWISE_USERNAME | 登录用户名 | 字符串 | |
| FLOWISE_PASSWORD | 登录密码 | 字符串 | |
| DEBUG | 打印组件的日志 | 布尔值 | |
| LOG_PATH | 存储日志文件的位置 | 字符串 | `your-path/Flowise/logs` |
| LOG_LEVEL | 日志的不同级别 | 枚举字符串: `error`, `info`, `verbose`, `debug` | `info` |
| APIKEY_PATH | 存储 API 密钥的位置 | 字符串 | `your-path/Flowise/packages/server` |
| EXECUTION_MODE | 预测是否在独立进程中运行还是在主进程中运行 | 枚举字符串: `child`, `main` | `main` |
| TOOL_FUNCTION_BUILTIN_DEP | 用于工具函数的 NodeJS 内置模块 | 字符串 | |
| TOOL_FUNCTION_EXTERNAL_DEP | 用于工具函数的外部模块 | 字符串 | |
| OVERRIDE_DATABASE | 是否使用默认值覆盖当前数据库 | 枚举字符串: `true`, `false` | `true` |
| DATABASE_TYPE | 存储 flowise 数据的数据库类型 | 枚举字符串: `sqlite`, `mysql`, `postgres` | `sqlite` |
| DATABASE_PATH | 数据库保存的位置（当 DATABASE_TYPE 是 sqlite 时） | 字符串 | `your-home-dir/.flowise` |
| DATABASE_HOST | 主机 URL 或 IP 地址（当 DATABASE_TYPE 不是 sqlite 时） | 字符串 | |
| DATABASE_PORT | 数据库端口（当 DATABASE_TYPE 不是 sqlite 时） | 字符串 | |
| DATABASE_USERNAME | 数据库用户名（当 DATABASE_TYPE 不是 sqlite 时） | 字符串 | |
| DATABASE_PASSWORD | 数据库密码（当 DATABASE_TYPE 不是 sqlite 时） | 字符串 | |
| DATABASE_NAME | 数据库名称（当 DATABASE_TYPE 不是 sqlite 时） | 字符串 | |
您也可以在使用 `npx` 时指定环境变量。例如：
```
npx flowise start --PORT=3000 --DEBUG=true
```
## 📖 贡献文档
[Flowise 文档](https://github.com/FlowiseAI/FlowiseDocs)
## 🏷️ Pull Request 流程
当您打开一个 Pull Request 时，FlowiseAI 团队的成员将自动收到通知/指派。您也可以在 [Discord](https://discord.gg/jbaHfsRVBW) 上联系我们。
##

2
CONTRIBUTING.md
View File

@ -2,6 +2,8 @@
# Contributing to Flowise # Contributing to Flowise
English | [中文](<./CONTRIBUTING-ZH.md>)
We appreciate any form of contributions. We appreciate any form of contributions.
## ⭐ Star ## ⭐ Star

184
README-ZH.md Normal file
View File

@ -0,0 +1,184 @@
<!-- markdownlint-disable MD030 -->
<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.png?raw=true"></a>
# Flowise - 轻松构建LLM应用程序
[![发布说明](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关注](https://img.shields.io/twitter/follow/FlowiseAI?style=social)](https://twitter.com/FlowiseAI)
[![GitHub星图](https://img.shields.io/github/stars/FlowiseAI/Flowise?style=social)](https://star-history.com/#FlowiseAI/Flowise)
[![GitHub分支](https://img.shields.io/github/forks/FlowiseAI/Flowise?style=social)](https://github.com/FlowiseAI/Flowise/fork)
[English](<./README.md>) | 中文
<h3>拖放界面构建定制化的LLM流程</h3>
<a href="https://github.com/FlowiseAI/Flowise">
<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.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
```
使用用户名和密码
```bash
npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234
```
3. 打开 [http://localhost:3000](http://localhost:3000)
## 🐳 Docker
### Docker Compose
1. 进入项目根目录下的 `docker` 文件夹
2. 创建 `.env` 文件并指定 `PORT`（参考 `.env.example`）
3. 运行 `docker-compose up -d`
4. 打开 [http://localhost:3000](http://localhost:3000)
5. 可以通过 `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 在一个单一的代码库中有3个不同的模块。
- `server`：用于提供 API 逻辑的 Node 后端
- `ui`：React 前端
- `components`：Langchain 组件
### 先决条件
- 安装 [Yarn v1](https://classic.yarnpkg.com/en/docs/install)
```bash
npm i -g yarn
```
### 设置
1. 克隆仓库
```bash
git clone https://github.com/FlowiseAI/Flowise.git
```
2. 进入仓库文件夹
```bash
cd Flowise
```
3. 安装所有模块的依赖：
```bash
yarn install
```
4. 构建所有代码：
```bash
yarn build
```
5. 启动应用：
```bash
yarn start
```
现在可以在 [http://localhost:3000](http://localhost:3000) 访问应用
6. 用于开发构建：
- 在 `packages/ui` 中创建 `.env` 文件并指定 `PORT`（参考 `.env.example`）
- 在 `packages/server` 中创建 `.env` 文件并指定 `PORT`（参考 `.env.example`）
- 运行
```bash
yarn dev
```
任何代码更改都会自动重新加载应用程序，访问 [http://localhost:8080](http://localhost:8080)
## 🔒 认证
要启用应用程序级身份验证，在 `packages/server` 的 `.env` 文件中添加 `FLOWISE_USERNAME` 和 `FLOWISE_PASSWORD`：
```
FLOWISE_USERNAME=user
FLOWISE_PASSWORD=1234
```
## 🌱 环境变量
Flowise 支持不同的环境变量来配置您的实例。您可以在 `packages/server` 文件夹中的 `.env` 文件中指定以下变量。了解更多信息，请阅读[文档](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables)
## 📖 文档
[Flowise 文档](https://docs.flowiseai.com/)
## 🌐 自托管
### [Railway](https://docs.flowiseai.com/deployment/railway)
[![在 Railway 上部署](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)
### [Render](https://docs.flowiseai.com/deployment/render)
[![部署到 Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
### [AWS](https://docs.flowiseai.com/deployment/aws)
### [Azure](https://docs.flowiseai.com/deployment/azure)
### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
### [GCP](https://docs.flowiseai.com/deployment/gcp)
## 💻 云托管
即将推出
## 🙋 支持
在[讨论区](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)上与我们联系。
## 📄 许可证
此代码库中的源代码在[MIT许可证](LICENSE.md)下提供。

2
README.md
View File

@ -10,6 +10,8 @@
[![GitHub star chart](https://img.shields.io/github/stars/FlowiseAI/Flowise?style=social)](https://star-history.com/#FlowiseAI/Flowise) [![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) [![GitHub fork](https://img.shields.io/github/forks/FlowiseAI/Flowise?style=social)](https://github.com/FlowiseAI/Flowise/fork)
English | [中文](<./README-ZH.md>)
<h3>Drag & drop UI to build your customized LLM flow</h3> <h3>Drag & drop UI to build your customized LLM flow</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.gif?raw=true"></a> <img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true"></a>

19
packages/components/README-ZH.md Normal file
View File

@ -0,0 +1,19 @@
<!-- markdownlint-disable MD030 -->
# 流式组件
[English](<./README.md>) | 中文
Flowise的应用集成。包含节点和凭据。
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)
安装：
```bash
npm i flowise-components
```
## 许可证
此存储库中的源代码在[MIT许可证](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md)下提供。

2
packages/components/README.md
View File

@ -2,6 +2,8 @@
# Flowise Components # Flowise Components
English | [中文](<./README-ZH.md>)
Apps integration for Flowise. Contain Nodes and Credentials. Apps integration for Flowise. Contain Nodes and Credentials.
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true) ![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)

101
packages/server/README-ZH.md Normal file
View File

@ -0,0 +1,101 @@
<!-- markdownlint-disable MD030 -->
# Flowise - 低代码LLM应用程序构建器
[English](<./README.md>) | 中文
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)
拖放界面来构建自定义的LLM流程
## ⚡快速入门
1. 安装Flowise
```bash
npm install -g flowise
```
2. 启动Flowise
```bash
npx flowise start
```
3. 打开[http://localhost:3000](http://localhost:3000)
## 🔒 身份验证
要启用应用级身份验证，请将`FLOWISE_USERNAME`和`FLOWISE_PASSWORD`添加到`.env`文件中：
```
FLOWISE_USERNAME=user
FLOWISE_PASSWORD=1234
```
## 🌱 环境变量
Flowise支持不同的环境变量来配置您的实例。您可以在`packages/server`文件夹中的`.env`文件中指定以下变量。阅读[更多](https://docs.flowiseai.com/environment-variables)
| 变量 | 描述 | 类型 | 默认值 |
| ---------------- | ---------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| PORT | Flowise运行的HTTP端口 | 数字 | 3000 |
| FLOWISE_USERNAME | 登录的用户名 | 字符串 | |
| FLOWISE_PASSWORD | 登录的密码 | 字符串 | |
| DEBUG | 打印组件的日志 | 布尔值 | |
| LOG_PATH | 存储日志文件的位置 | 字符串 | `your-path/Flowise/logs` |
| LOG_LEVEL | 日志的不同级别 | 枚举字符串：`error`、`info`、`verbose`、`debug` | `info` |
| APIKEY_PATH | 存储API密钥的位置 | 字符串 | `your-path/Flowise/packages/server` |
| EXECUTION_MODE | 预测是在其自己的进程中运行还是在主进程中运行 | 枚举字符串：`child`、`main` | `main` |
| TOOL_FUNCTION_BUILTIN_DEP | 用于工具函数的NodeJS内置模块 | 字符串 | |
| TOOL_FUNCTION_EXTERNAL_DEP | 用于工具函数的外部模块 | 字符串 | |
| OVERRIDE_DATABASE | 使用默认值覆盖当前数据库 | 枚举字符串：`true`、`false` | `true` |
| DATABASE_TYPE | 存储flowise数据的数据库类型 | 枚举字符串：`sqlite`、`mysql`、`postgres` | `sqlite` |
| DATABASE_PATH | 数据库的保存位置（当DATABASE_TYPE为sqlite时） | 字符串 | `your-home-dir/.flowise` |
| DATABASE_HOST | 主机URL或IP地址（当DATABASE_TYPE不为sqlite时） | 字符串 | |
| DATABASE_PORT | 数据库端口（当DATABASE_TYPE不为sqlite时） | 字符串 | |
| DATABASE_USERNAME | 数据库用户名（当DATABASE_TYPE不为sqlite时） | 字符串 | |
| DATABASE_PASSWORD | 数据库密码（当DATABASE_TYPE不为sqlite时） | 字符串 | |
| DATABASE_NAME | 数据库名称（当DATABASE_TYPE不为sqlite时） | 字符串 | |
您还可以在使用`npx`时指定环境变量。例如：
```
npx flowise start --PORT=3000 --DEBUG=true
```
## 📖 文档
[Flowise文档](https://docs.flowiseai.com/)
## 🌐 自托管
### [Railway](https://docs.flowiseai.com/deployment/railway)
[![在Railway上部署](https://railway.app/button.svg)](https://railway.app/template/YK7J0v)
### [Render](https://docs.flowiseai.com/deployment/render)
[![部署到Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
### [AWS](https://docs.flowiseai.com/deployment/aws)
### [Azure](https://docs.flowiseai.com/deployment/azure)
### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
### [GCP](https://docs.flowiseai.com/deployment/gcp)
## 💻 云托管
即将推出
## 🙋 支持
在[讨论区](https://github.com/FlowiseAI/Flowise/discussions)中随时提出任何问题、报告问题和请求新功能。
## 🙌 贡献
请参阅[贡献指南](https://github.com/FlowiseAI/Flowise/blob/master/CONTRIBUTING.md)。如果您有任何问题或问题，请在[Discord](https://discord.gg/jbaHfsRVBW)上与我们联系。
## 📄 许可证
本仓库中的源代码在[MIT许可证](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md)下提供。

2
packages/server/README.md
View File

@ -2,6 +2,8 @@
# Flowise - Low-Code LLM apps builder # Flowise - Low-Code LLM apps builder
English | [中文](<./README-ZH.md>)
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true) ![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)
Drag & drop UI to build your customized LLM flow Drag & drop UI to build your customized LLM flow

19
packages/ui/README-ZH.md Normal file
View File

@ -0,0 +1,19 @@
<!-- markdownlint-disable MD030 -->
# 流程界面
[English](<./README.md>) | 中文
Flowise的React前端界面。
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)
安装：
```bash
npm i flowise-ui
```
## 许可证
本仓库中的源代码在[MIT许可证](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md)下提供。

2
packages/ui/README.md
View File

@ -2,6 +2,8 @@
# Flowise UI # Flowise UI
English | [中文](<./README-ZH.md>)
React frontend ui for Flowise. React frontend ui for Flowise.
![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true) ![Flowise](https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true)