FlowGram.AI 开源项目教程

FlowGram.AI 开源项目教程

flowgram.ai 项目地址: https://gitcode.com/gh_mirrors/fl/flowgram.ai

1. 项目介绍

FlowGram 是一个基于节点的流程构建引擎，旨在帮助开发者快速创建固定布局或自由连接布局的工作流。它提供了一套交互最佳实践，特别适合于具有清晰输入和输出的可视化工作流。在当前的AI热潮中，FlowGram 也在关注如何将AI能力赋予工作流，这也是我们在名称中加入AI后缀的原因。

2. 项目快速启动

首先，确保您已经安装了Node.js 18+。如果没有安装，可以使用以下命令进行安装：

nvm install lts/hydrogen
nvm alias default lts/hydrogen
nvm use lts/hydrogen

然后，克隆仓库：

git clone git@github.com:bytedance/flowgram.ai.git

安装必要的全局依赖：

npm i -g pnpm@9.12.0 @microsoft/rush@5.140.0

接着，安装项目依赖：

rush update

构建项目：

rush build

最后，运行文档或示例：

rush dev:docs
# 或者运行以下任一示例
rush dev:demo-fixed-layout
rush dev:demo-free-layout

启动后，您可以开始在这个仓库中开发项目了。

3. 应用案例和最佳实践

固定布局案例

在固定布局模式中，节点可以被拖动到指定的位置，并支持复合节点，如分支和循环。

自由布局案例

在自由布局模式中，节点可以放置在任何位置，并通过自由形式的线条连接。

最佳实践

• 保持工作流简洁明了，避免过度复杂化。
• 使用适当的命名约定，以提高代码的可读性。
• 在节点之间建立清晰的输入输出关系。

4. 典型生态项目

FlowGram 生态系统中的项目包括但不限于以下几种：

• @flowgram.ai/create-app: 应用创建器，用于快速搭建新项目。
• @flowgram.ai/fixed-layout-editor: 固定布局编辑器，用于编辑固定布局工作流。
• @flowgram.ai/free-layout-editor: 自由布局编辑器，用于编辑自由布局工作流。

通过这些项目，开发者可以更高效地构建和管理工作流，同时也可以通过插件和扩展来增强FlowGram的功能。

flowgram.ai 项目地址: https://gitcode.com/gh_mirrors/fl/flowgram.ai