-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
My native language is Simplified Chinese, so the i18n process is divi…
…ded into stages. Currently, the Readme file is being translated into Chinese, and later on, i18next and react-i18next will be used for multilingual support.
- Loading branch information
1 parent
b7ddfdf
commit 6c1dff8
Showing
12 changed files
with
541 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<!-- markdownlint-disable MD030 --> | ||
|
||
# 贡献者公约行为准则 | ||
|
||
[English](<./CODE_OF_CONDUCT.md>) | 中文 | ||
|
||
## 我们的承诺 | ||
|
||
为了促进一个开放和友好的环境,我们作为贡献者和维护者承诺,使参与我们的项目和社区的体验对每个人来说都是无骚扰的,无论年龄、体型、残疾、种族、性别认同和表达、经验水平、国籍、个人形象、种族、宗教或性取向如何。 | ||
|
||
## 我们的标准 | ||
|
||
有助于创建积极环境的行为示例包括: | ||
|
||
- 使用友好和包容性的语言 | ||
- 尊重不同的观点和经验 | ||
- 优雅地接受建设性的批评 | ||
- 关注社区最有利的事情 | ||
- 向其他社区成员表达同理心 | ||
|
||
参与者不可接受的行为示例包括: | ||
|
||
- 使用性暗示的语言或图像和不受欢迎的性关注或进展 | ||
- 恶作剧、侮辱/贬低的评论和个人或政治攻击 | ||
- 公开或私下骚扰 | ||
- 未经明确许可发布他人的私人信息,如实际或电子地址 | ||
- 在专业环境中可能被合理认为不适当的其他行为 | ||
|
||
## 我们的责任 | ||
|
||
项目维护者有责任明确可接受行为的标准,并预期对任何不可接受行为的情况采取适当和公正的纠正措施。 | ||
|
||
项目维护者有权和责任删除、编辑或拒绝不符合本行为准则的评论、提交、代码、维基编辑、问题和其他贡献,或者临时或永久禁止任何贡献者,如果他们认为其行为不适当、威胁、冒犯或有害。 | ||
|
||
## 适用范围 | ||
|
||
本行为准则适用于项目空间和公共空间,当个人代表项目或其社区时。代表项目或社区的示例包括使用官方项目电子邮件地址、通过官方社交媒体账号发布或在线或离线活动中担任指定代表。项目的代表可以由项目维护者进一步定义和澄清。 | ||
|
||
## 执法 | ||
|
||
可以通过联系项目团队 [email protected] 来报告滥用、骚扰或其他不可接受的行为。所有投诉将经过审核和调查,并将得出视情况认为必要和适当的回应。项目团队有义务对事件举报人保持机密。具体执行政策的更多细节可能会单独发布。 | ||
|
||
如果项目维护者不诚信地遵守或执行行为准则,可能会面临其他项目领导成员决定的临时或永久的后果。 | ||
|
||
## 归属 | ||
|
||
本行为准则改编自[贡献者公约][主页],版本1.4,可在[http://contributor-covenant.org/version/1/4][版本]上获取。 | ||
|
||
[主页]: http://contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) 上联系我们。 | ||
## |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.