9.6 KiB

Raw Blame History

贡献给 Flowise

English | 中文

我们欢迎任何形式的贡献。

⭐ 点赞

点赞并分享Github 仓库。

🙋 问题和回答

在问题和回答部分搜索任何问题，如果找不到，可以毫不犹豫地创建一个。这可能会帮助到其他有类似问题的人。

🙌 分享 Chatflow

是的！分享你如何使用 Flowise 是一种贡献方式。将你的 Chatflow 导出为 JSON，附上截图并在展示和分享部分分享。

💡 想法

欢迎各种想法，如新功能、应用集成和区块链网络。在想法部分提交。

🐞 报告错误

发现问题了吗？报告它。

👨‍💻 贡献代码

不确定要贡献什么？一些想法：

从 packages/components 创建新组件
更新现有组件，如扩展功能、修复错误
添加新的 Chatflow 想法

开发人员

Flowise 在一个单一的单体存储库中有 3 个不同的模块。

server：用于提供 API 逻辑的 Node 后端
ui：React 前端
components：Langchain/LlamaIndex 组件

先决条件

安装 PNPM
```
npm i -g pnpm
```

逐步指南

Fork 官方的Flowise Github 仓库。
克隆你 fork 的存储库。
创建一个新的分支，参考指南。命名约定：
- 对于功能分支：feature/<你的新功能>
- 对于 bug 修复分支：bugfix/<你的新bug修复>。
切换到新创建的分支。
进入存储库文件夹
```
cd Flowise
```
安装所有模块的依赖项：
```
pnpm install
```
构建所有代码：
```
pnpm build
```
在http://localhost:3000上启动应用程序
```
pnpm start
```
开发时：
- 在packages/ui中创建.env文件并指定VITE_PORT（参考.env.example）
- 在packages/server中创建.env文件并指定PORT（参考.env.example）
- 运行
```
pnpm dev
```
对packages/ui或packages/server进行的任何更改都将反映在http://localhost:8080上

对于packages/components中进行的更改，再次运行pnpm build以应用更改。
做完所有的更改后，运行以下命令来确保在生产环境中一切正常：
```
pnpm build
```
和
```
pnpm start
```
提交代码并从指向 Flowise 主分支的分叉分支上提交 Pull Request。

🌱 环境变量

Flowise 支持不同的环境变量来配置您的实例。您可以在 packages/server 文件夹中的 .env 文件中指定以下变量。阅读更多信息

变量名	描述	类型	默认值
PORT	Flowise 运行的 HTTP 端口	数字	3000
FLOWISE_USERNAME	登录用户名	字符串
FLOWISE_PASSWORD	登录密码	字符串
FLOWISE_FILE_SIZE_LIMIT	上传文件大小限制	字符串	50mb
DISABLE_CHATFLOW_REUSE	强制为每次调用创建一个新的 ChatFlow，而不是重用缓存中的现有 ChatFlow	布尔值
DEBUG	打印组件的日志	布尔值
LOG_PATH	存储日志文件的位置	字符串	`your-path/Flowise/logs`
LOG_LEVEL	日志的不同级别	枚举字符串: `error`, `info`, `verbose`, `debug`	`info`
APIKEY_PATH	存储 API 密钥的位置	字符串	`your-path/Flowise/packages/server`
TOOL_FUNCTION_BUILTIN_DEP	用于工具函数的 NodeJS 内置模块	字符串
TOOL_FUNCTION_EXTERNAL_DEP	用于工具函数的外部模块	字符串
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 时）	字符串
SECRETKEY_PATH	保存加密密钥（用于加密/解密凭据）的位置	字符串	`your-path/Flowise/packages/server`
FLOWISE_SECRETKEY_OVERWRITE	加密密钥用于替代存储在 SECRETKEY_PATH 中的密钥	字符串
DISABLE_FLOWISE_TELEMETRY	关闭遥测	字符串
MODEL_LIST_CONFIG_JSON	加载模型的位置	字符	`/your_model_list_config_file_path`
STORAGE_TYPE	上传文件的存储类型	枚举字符串: `local`, `s3`	`local`
BLOB_STORAGE_PATH	上传文件存储的本地文件夹路径, 当`STORAGE_TYPE`是`local`	字符串	`your-home-dir/.flowise/storage`
S3_STORAGE_BUCKET_NAME	S3 存储文件夹路径, 当`STORAGE_TYPE`是`s3`	字符串
S3_STORAGE_ACCESS_KEY_ID	AWS 访问密钥 (Access Key)	字符串
S3_STORAGE_SECRET_ACCESS_KEY	AWS 密钥 (Secret Key)	字符串
S3_STORAGE_REGION	S3 存储地区	字符串

您也可以在使用 npx 时指定环境变量。例如：

npx flowise start --PORT=3000 --DEBUG=true

📖 贡献文档

Flowise 文档

🏷️ Pull Request 流程

当您打开一个 Pull Request 时，FlowiseAI 团队的成员将自动收到通知/指派。您也可以在 Discord 上联系我们。

9.6 KiB Raw Blame History Unescape Escape