synergycodes/workflowbuilder
Workflow orchestration framework for your product, open source: a white-label React workflow builder, durable execution on your own Temporal, human approval steps for AI agents, and a live view of every run.
这是什么
Workflow Builder 是一个开源、Apache-2.0 许可的 SDK,可让您将可视化、拖放式工作流编辑器放入任何 React 应用程序中。该编辑器基于 React Flow 构建,并附带插件化架构、设计系统 UI 套件和一个可运行工作流的参考后端(使用 Temporal——一个持久化工作流引擎)。该仓库包含 SDK、演示 SPA、文档网站以及一个展示 AI 代理节点的全栈参考实现(前端 + Hono API + Temporal 工作进程 + Postgres)。
谁可以使用
- 需要在 SaaS 产品(例如规则引擎、自动化构建器、低代码平台)中集成现成可视化工作流画布的前端工程师。
- 正在构建 AI 代理或 RAG 流水线并希望有 UI 来连接触发器、决策、LLM 调用和可视化步骤的产品团队。
- 已经使用 Temporal 进行持久化工作流并希望有一个 UI 层来生成 Temporal 可执行的 JSON 的公司。
- 有兴趣扩展插件系统(新节点类型、自定义布局、PDF 导出等)的开源贡献者。
工作方式——概览
| 组件 | 角色 |
|---|---|
@workflowbuilder/sdk(packages/sdk) |
可供导入的 React 组件库(<WorkflowBuilder.Root …/>)。负责渲染、状态持久化、主题设置,并暴露了干净干净的嵌入 API。 |
@workflowbuilder/ui(packages/ui) |
SDK 所依赖的低级 UI 原语(按钮、面板、图标)。可独立用于自定义主题。 |
| 插件系统 | 可在运行时加载的可选包(例如,撤销/重做、PDF 导出、ELK 自动布局)。可以添加或移除插件而不会破坏核心编辑器。 |
参考后端(apps/backend) |
一个小型 Hono 服务器,用于存储工作流定义、流式传输执行日志,并将运行请求转发给工作进程。 |
执行工作进程(apps/execution-worker) |
一个 Temporal 工作进程,负责解释 JSON 工作流、运行内置节点执行器(触发器、决策、可视化)以及调用 OpenAI 兼容端点的 AI 代理节点。 |
apps/ai-studio |
将编辑器关联到后端/工作进程的前端 UI,显示实时执行状态(使用相同的 SDK)。 |
| Docker compose 栈 | 启动 Postgres、Temporal DB、Temporal 服务器/UI 以及后端/工作进程,以便在本地尝试端到端演示。 |
开发人员通常嵌入 SDK(路径 A)进行快速集成,或运行完整堆栈(路径 C)来试验支持 AI 的工作流。
仓库内容
- Monorepo——使用
pnpm workspaces管理——包含独立的apps/(演示、文档、后端、工作进程)和packages/(SDK、UI、类型、执行核心、Temporal 插件)。 - CLI 辅助工具(
pnpm preflight、pnpm dev:demo、pnpm dev:ai-studio、pnpm infra:up/down)——用于快速本地设置。 - 插件示例(复制粘贴、PDF 导出、ELK 布局、撤销/重做等)——展示如何扩展编辑器。
- 文档网站(
apps/docs)——包含指南、API 参考和升级说明。 - AI 工作流示例——包含一个 AI 代理节点;可通过在
.env文件中设置AI_API_KEY、AI_BASE_URL和AI_MODEL来连接真实的 LLM。
如何开始(快速版)
- 仅嵌入——运行
npm i @workflowbuilder/sdk @xyflow/react zustand,然后在 React 应用中渲染<WorkflowBuilder.Root name="my-workflow" />。 - 运行演示——克隆仓库,运行
pnpm install && pnpm dev:demo,然后打开http://localhost:4200。 - 全栈——克隆后,运行
pnpm setup:env && pnpm infra:up && pnpm -F backend db:migrate && pnpm dev:ai-studio。打开http://localhost:4201访问 AI Studio UI,打开http://localhost:8233访问 Temporal UI。
何时考虑企业版
开源版本适用于本地开发和概念验证。它附带一个 没有认证、没有多租户隔离、CORS 完全开放 的参考后端。对于生产环境,您应该针对 WorkflowEnginePort 接口构建自己的安全后端,或者购买商业 Workflow Builder Enterprise 产品,该产品增加了身份验证、基于角色的访问、扩展工具和专业支持。
以上所有细节均直接取自仓库的 README;未添加任何外部假设。
相关
- 项目
- 项目
- 项目
- 项目
- 项目