docs: make Chinese README the default
CI / build (push) Has been cancelled

This commit is contained in:
wehub-resource-sync
2026-07-13 10:15:35 +00:00
parent 74bb1138d5
commit b1f0fae136
+48 -42
View File
@@ -1,3 +1,9 @@
<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/bytedance/flowgram.ai) · [上游 README](https://github.com/bytedance/flowgram.ai/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
![Image](https://github.com/user-attachments/assets/4f9dfa0e-e600-4d4e-9e73-c919184f7573)
<div align="center">
@@ -8,35 +14,35 @@
</div>
# FlowGramWorkflow development framework
# FlowGram.AI|工作流开发框架
[English](README.md) | [中文](README_ZH.md) | [Español](README_ES.md) | [Русский](README_RU.md) | [Português](README_PT.md) | [Deutsch](README_DE.md) | [日本語](README_JA.md)
FlowGram is a composable, visual, easy-to-integrate, and extensible workflow development framework & toolkit.
Our goal is to help developers build AI workflow platforms **faster** and **simpler**.
FlowGram comes with a suite of built-in tools for workflow development: flow canvas, node configuration form, variable scope chain, and ready-to-use materials (LLM, Condition, Code Editor etc). Its not a ready-made workflow platform; its the framework and toolkit to build yours.
FlowGram 是一个可组合、可视化、易于集成且可扩展的工作流开发框架与工具集。
我们的目标是帮助开发者以更快、更简单的方式搭建 AI 工作流平台。
FlowGram 内置开箱开箱即用的工作流开发能力:可视化流程画布、节点配置表单、变量作用域链,以及开箱即用的物料(LLM、条件、代码编辑器等)。这并非一个现成的工作流平台,而是帮助你构建平台的框架与工具。
Learn more at [FlowGram.AI 🌐](https://flowgram.ai)
了解更多 [FlowGram.AI 🌐](https://flowgram.ai)
## 🎬 Demo
## 🎬 演示
<https://github.com/user-attachments/assets/fee87890-ceec-4c07-b659-08afc4dedc26>
Open in [CodeSandbox 🌐](https://codesandbox.io/p/github/louisyoungx/flowgram-demo/main) or [StackBlitz 🌐](https://stackblitz.com/~/github.com/louisyoungx/flowgram-demo)
[CodeSandbox 🌐](https://codesandbox.io/p/github/louisyoungx/flowgram-demo/main) [StackBlitz 🌐](https://stackblitz.com/~/github.com/louisyoungx/flowgram-demo) 中打开
In this demo, we iterate through a list of cities, fetch real-time weather via HTTP, parse temperatures with a Code node, generate outfit suggestions with an LLM, gate by a Condition, aggregate results across the loop, and finally use an Advisor LLM to pick the most comfortable city before sending the result to the End node.
在该演示中,我们遍历一组城市,通过 HTTP 获取实时天气,用 Code 节点解析温度,借助 LLM 生成穿搭建议,经由 Condition 进行筛选,在循环中汇总结果,最后使用 Advisor LLM 选出最舒适的城市,并将结果发送至 End 节点。
## 🚀 Quick Start
## 🚀 快速上手
1. Create a new FlowGram project:
1. 创建一个新的 FlowGram 项目:
```sh
npx @flowgram.ai/create-app@latest
```
> We recommend choosing the `Free Layout Demo ⭐️` template.
> 我们推荐选择 `Free Layout Demo ⭐️` 模板。
2. Start the project:
2. 启动项目:
```sh
cd demo-free-layout
@@ -44,48 +50,48 @@ npm install
npm start
```
3. Open [http://localhost:3000](http://localhost:3000) in your browser.
3. 在浏览器中打开 [http://localhost:3000](http://localhost:3000)
## ✨ Features
## ✨ 特性
| Feature | Description | Demo |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [Free Layout Canvas](https://flowgram.ai/examples/free-layout/free-feature-overview.html) | Free layout canvas where nodes can be placed anywhere and connected using free-form lines. | ![Free Layout Demo](./apps/docs/src/public/free-layout/free-layout-demo.gif) |
| [Fixed Layout Canvas](https://flowgram.ai/examples/fixed-layout/fixed-feature-overview.html) | Fixed layout canvas where nodes can be dragged to specified positions, with support for compound nodes like branches and loops. | ![Fixed Layout Demo](./apps/docs/src/public/fixed-layout/fixed-layout-demo.gif) |
| [Form](https://flowgram.ai/examples/node-form/basic.html) | The form engine manages the CRUD operations of node data and provides rendering, validation, side effects, linkage, and error-capturing capabilities, simplifying the development of node configurations. | ![Form](https://github.com/user-attachments/assets/13e9b4cd-e993-4d21-901c-fb6cf106de78) |
| [Variable](https://flowgram.ai/guide/variable/basic.html) | The variable engine supports scope constraints, variable structure inspection, and type inference, making it easy to manage data flow within the workflow. | ![Variable](https://github.com/user-attachments/assets/442006db-25e3-4fb5-972c-7a0545638ff5) |
| 特性 | 说明 | 演示 |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [Free Layout Canvas](https://flowgram.ai/examples/free-layout/free-feature-overview.html) | 自由布局画布,节点可任意摆放,可在节点间创建边进行链接。 | ![Free Layout Demo](./apps/docs/src/public/free-layout/free-layout-demo.gif) |
| [Fixed Layout Canvas](https://flowgram.ai/examples/fixed-layout/fixed-feature-overview.html) | 固定布局画布,节点可拖拽至指定位置,支持复合节点(如分支与循环)。 | ![Fixed Layout Demo](./apps/docs/src/public/fixed-layout/fixed-layout-demo.gif) |
| [Form](https://flowgram.ai/examples/node-form/basic.html) | 表单引擎管理节点数据的增删改查操作,并提供渲染、验证、副作用、联动和错误捕获等功能,简化节点配置的开发。 | ![Form](https://github.com/user-attachments/assets/13e9b4cd-e993-4d21-901c-fb6cf106de78) |
| [Variable](https://flowgram.ai/guide/variable/basic.html) | 变量引擎支持作用域约束、变量结构检查和类型推断等功能,便于管理工作流中的数据流。 | ![Variable](https://github.com/user-attachments/assets/442006db-25e3-4fb5-972c-7a0545638ff5) |
## 📖 文档
## 📖 Documentation
你可以在官网查阅完整文档:[FlowGram 文档](https://flowgram.ai)。
You can find the FlowGram documentation [on the website](https://flowgram.ai).
文档分为以下章节:
The documentation is divided into several sections:
- [快速入门](https://flowgram.ai/guide/getting-started/introduction.html)
- [自由画布](https://flowgram.ai/guide/free-layout/load.html)
- [固定画布](https://flowgram.ai/guide/fixed-layout/load.html)
- [表单](https://flowgram.ai/guide/form/form.html)
- [变量](https://flowgram.ai/guide/variable/basic.html)
- [素材](https://flowgram.ai/materials/introduction.html)
- [运行时](https://flowgram.ai/guide/runtime/introduction.html)
- [进阶指南](https://flowgram.ai/guide/advanced/zoom-scroll.html)
- [API 参考](https://flowgram.ai/api/index.html)
- [获取支持](https://flowgram.ai/guide/contact-us.html)
- [贡献指南](https://flowgram.ai/guide/contributing.html)
- [Quick Start](https://flowgram.ai/guide/getting-started/introduction.html)
- [Canvas](https://flowgram.ai/guide/free-layout/load.html)
- [Form](https://flowgram.ai/guide/form/form.html)
- [Variable](https://flowgram.ai/guide/variable/basic.html)
- [Material](https://flowgram.ai/materials/introduction.html)
- [Runtime](https://flowgram.ai/guide/runtime/introduction.html)
- [Advanced Guides](https://flowgram.ai/guide/advanced/zoom-scroll.html)
- [API Reference](https://flowgram.ai/api/index.html)
- [Where to get Support](https://flowgram.ai/guide/contact-us.html)
- [Contributing Guide](https://flowgram.ai/guide/contributing.html)
## 🙌 Contributors
## 🙌 贡献者
[![FlowGram.AI Contributors](https://contrib.rocks/image?repo=bytedance/flowgram.ai)](https://github.com/bytedance/flowgram.ai/graphs/contributors)
## 🌍 Adoption
## 🌍 被这些项目采用
- [Coze Studio](https://github.com/coze-dev/coze-studio) is an all-in-one AI agent development tool. Providing the latest large models and tools, various development modes and frameworks, Coze Studio offers the most convenient AI agent development environment, from development to deployment.
- [NNDeploy](https://github.com/NNDeploy/nndeploy) is a workflow-based multi-platform ai deployment tool.
- [Certimate](https://github.com/certimate-go/certimate) is an open-source SSL certificate management tool that helps you automatically apply for and deploy SSL certificates with a visual workflow. It is one of the ACME client options listed in the official documentation of Let's Encrypt.
- [Coze Studio](https://github.com/coze-dev/coze-studio) 是一体化的 AI Agent 开发工具,提供最新的大模型与工具、多样的开发模式与框架,并在从开发到部署的全流程中,提供最便捷的 Agent 开发体验。
- [NNDeploy](https://github.com/NNDeploy/nndeploy) 是一个基于工作流的多平台 AI 部署工具。
- [Certimate](https://github.com/certimate-go/certimate) 是开源的 SSL 证书管理工具,借助可视化工作流帮助你自动申请与部署证书;它也是官方文档列出的 Let's Encrypt ACME 客户端选项之一。
## 📬 Contact us
## 📬 联系我们
- Issues: [Issues](https://github.com/bytedance/flowgram.ai/issues)
- Lark: Scan the QR code below with [Register Feishu](https://www.feishu.cn/en/) to join our FlowGram user group.
- 问题反馈: [Issues](https://github.com/bytedance/flowgram.ai/issues)
- 飞书:使用 [Register Feishu](https://www.feishu.cn/en/) 扫码下方二维码,加入 FlowGram 用户群。
<img src="./apps/docs/src/public/lark-group.png" width="200"/>