|
|
@@ -1,140 +1,91 @@
|
|
|
-# FlowGram.AI
|
|
|
-
|
|
|
-FlowGram is a node-based flow building engine that helps developers quickly create workflows in either fixed layout or
|
|
|
-free connection layout modes. It provides a set of interaction best practices and is particularly suitable for visual
|
|
|
-workflows with clear inputs and outputs.
|
|
|
-
|
|
|
-In the current AI boom, we are also focusing on how to empower workflows with AI capabilities, hence the AI suffix in
|
|
|
-our name.
|
|
|
+
|
|
|
|
|
|
<div align="center">
|
|
|
|
|
|
-[](https://github.com/bytedance/flowgram.ai/blob/main/LICENSE)
|
|
|
-[](https://www.npmjs.com/package/@flowgram.ai/editor)
|
|
|
-[](https://deepwiki.com/bytedance/flowgram.ai)
|
|
|
-[](https://juejin.cn/column/7479814468601315362)
|
|
|
-
|
|
|
+[](https://github.com/bytedance/flowgram.ai/blob/main/LICENSE) [](https://www.npmjs.com/package/@flowgram.ai/editor) [](https://deepwiki.com/bytedance/flowgram.ai) [](https://juejin.cn/column/7479814468601315362)
|
|
|
|
|
|
[](https://trendshift.io/repositories/13877)
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-## 📖 Documentation
|
|
|
+# FlowGram|Workflow development framework
|
|
|
|
|
|
-- [Official Documentation](https://flowgram.ai/)
|
|
|
-- [Contributing Guidelines](https://github.com/bytedance/flowgram.ai/blob/main/CONTRIBUTING.md)
|
|
|
-
|
|
|
-## 📦 Packages
|
|
|
-
|
|
|
-| Package | Description | Version |
|
|
|
-|---------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
-| [@flowgram.ai/create-app](./apps/create-app) | App Creator | [](https://www.npmjs.com/package/@flowgram.ai/create-app) |
|
|
|
-| [@flowgram.ai/fixed-layout-editor](./packages/client/fixed-layout-editor) | Fixed Layout Editor | [](https://www.npmjs.com/package/@flowgram.ai/fixed-layout-editor) |
|
|
|
-| [@flowgram.ai/free-layout-editor](./packages/client/free-layout-editor) | Free Layout Editor | [](https://www.npmjs.com/package/@flowgram.ai/free-layout-editor) |
|
|
|
-
|
|
|
-## 🎮 Examples
|
|
|
-
|
|
|
-<div>
|
|
|
- <p>
|
|
|
- <a href="https://flowgram.ai/examples/fixed-layout/fixed-feature-overview.html">
|
|
|
- Fixed Layout
|
|
|
- </a>
|
|
|
- </p>
|
|
|
- <p>
|
|
|
- Fixed layout where nodes can be dragged to specified positions, with support for compound nodes like branches and loops.
|
|
|
- </p>
|
|
|
- <p>
|
|
|
- <img src="./apps/docs/src/public/fixed-layout/fixed-layout-demo.gif"/>
|
|
|
- </p>
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- <p>
|
|
|
- <a href="https://flowgram.ai/examples/free-layout/free-feature-overview.html">
|
|
|
- Free Layout
|
|
|
- </a>
|
|
|
- </p>
|
|
|
- <p>
|
|
|
- Free layout where nodes can be placed anywhere and connected using free-form lines.
|
|
|
- </p>
|
|
|
- <p>
|
|
|
- <img src="./apps/docs/src/public/free-layout/free-layout-demo.gif"/>
|
|
|
- </p>
|
|
|
-</div>
|
|
|
+[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)
|
|
|
|
|
|
-## 🚀 Getting Started
|
|
|
+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). It’s not a ready-made workflow platform; it’s the framework and toolkit to build yours.
|
|
|
|
|
|
-```sh
|
|
|
-# create demo
|
|
|
-npx @flowgram.ai/create-app@latest
|
|
|
+Learn more at 🌐 [FlowGram.AI](https://flowgram.ai)
|
|
|
|
|
|
-# in PowerShell
|
|
|
-npx "@flowgram.ai/create-app@latest"
|
|
|
+## 🎬 Demo
|
|
|
|
|
|
-# select demo
|
|
|
-- fixed-layout # full-feature overview
|
|
|
-- free-layout # full-feature overview
|
|
|
-- fixed-layout-simple # basic usage
|
|
|
-- free-layout-simple # basic usage
|
|
|
-```
|
|
|
+<https://github.com/user-attachments/assets/fee87890-ceec-4c07-b659-08afc4dedc26>
|
|
|
|
|
|
-## 🔨 Development
|
|
|
+[Open in CodeSandbox](https://codesandbox.io/p/github/louisyoungx/flowgram-demo/main)
|
|
|
|
|
|
-1. **Install Node.js 18+**
|
|
|
+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.
|
|
|
|
|
|
-``` bash
|
|
|
-nvm install lts/hydrogen
|
|
|
-nvm alias default lts/hydrogen # set default node version
|
|
|
-nvm use lts/hydrogen
|
|
|
-```
|
|
|
+## 🚀 Quick start
|
|
|
|
|
|
-2. **Clone the repository**
|
|
|
+1. Create a new FlowGram project with preset templates
|
|
|
|
|
|
-``` bash
|
|
|
-git clone git@github.com:bytedance/flowgram.ai.git
|
|
|
+```sh
|
|
|
+npx @flowgram.ai/create-app@latest
|
|
|
```
|
|
|
|
|
|
-3. **Install required global dependencies**
|
|
|
+⭐️ Recommend to choose `Free Layout Demo`
|
|
|
+
|
|
|
+2. Start the project
|
|
|
|
|
|
-``` bash
|
|
|
-npm i -g pnpm@10.6.5 @microsoft/rush@5.150.0
|
|
|
+```sh
|
|
|
+cd demo-free-layout
|
|
|
+npm install
|
|
|
+npm start
|
|
|
```
|
|
|
|
|
|
-4. **Install project dependencies**
|
|
|
+3. Open the browser
|
|
|
|
|
|
-``` bash
|
|
|
-rush install
|
|
|
-```
|
|
|
+Enjoy it! [http://localhost:3000](http://localhost:3000)
|
|
|
|
|
|
-5. **Build the project**
|
|
|
+## ✨ Features
|
|
|
|
|
|
-``` bash
|
|
|
-rush build
|
|
|
-```
|
|
|
+| 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. |  |
|
|
|
+| [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. |  |
|
|
|
+| [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. |  |
|
|
|
+| [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. |  |
|
|
|
|
|
|
-6. **Run docs or demo**
|
|
|
|
|
|
-``` bash
|
|
|
-rush dev:docs # docs
|
|
|
-rush dev:demo-fixed-layout
|
|
|
-rush dev:demo-free-layout
|
|
|
-```
|
|
|
+## 📖 Documentation
|
|
|
+
|
|
|
+You can find the FlowGram documentation [on the website](https://flowgram.ai).
|
|
|
|
|
|
-After that, you can start to develop projects inside this repository.
|
|
|
+The documentation is divided into several sections:
|
|
|
|
|
|
-Enjoy it!
|
|
|
+- [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
|
|
|
+## 🙌 Contributors
|
|
|
|
|
|
[](https://github.com/bytedance/flowgram.ai/graphs/contributors)
|
|
|
|
|
|
-## 🌟 Adoption
|
|
|
+## 🌍 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.
|
|
|
|
|
|
-## 🌟 Contact us
|
|
|
+## 📬 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.
|