Nav apraksta

Yiwei Mao 867ceb8bc2 fix(materials): json schema title & variable selector long text style (#438) 6 mēneši atpakaļ
.github f048f6390d fix: cli polyfill (#365) 7 mēneši atpakaļ
.vscode aab4183d65 feat(runtime): flowgram workflow node.js runtime (#304) 7 mēneši atpakaļ
apps 867ceb8bc2 fix(materials): json schema title & variable selector long text style (#438) 6 mēneši atpakaļ
common cbefaa54fb chore: add license header (#432) 6 mēneši atpakaļ
config cbefaa54fb chore: add license header (#432) 6 mēneši atpakaļ
e2e cbefaa54fb chore: add license header (#432) 6 mēneši atpakaļ
packages 867ceb8bc2 fix(materials): json schema title & variable selector long text style (#438) 6 mēneši atpakaļ
.gitattributes d7bdf8a078 feat: init flowgram.ai 10 mēneši atpakaļ
.gitignore 867ceb8bc2 fix(materials): json schema title & variable selector long text style (#438) 6 mēneši atpakaļ
CHANGELOG.md 02e48ebdd9 feat(core): add flowing field to LineColor interface (#370) 7 mēneši atpakaļ
CNAME e63645253a chore: add cname 10 mēneši atpakaļ
CONTRIBUTING.md 082321bcdb docs(readme): optimize command and version for rush setup (#396) 6 mēneši atpakaļ
LICENSE d7bdf8a078 feat: init flowgram.ai 10 mēneši atpakaļ
README.md 082321bcdb docs(readme): optimize command and version for rush setup (#396) 6 mēneši atpakaļ
cspell.json 9d029bf335 feat(auto-layout): support custom layout config (#378) 7 mēneši atpakaļ
doc_build.sh cbefaa54fb chore: add license header (#432) 6 mēneši atpakaļ
rush.json da78b36fd1 feat: Add demo-nextjs-antd demo and free-antd-materials package (#366) 7 mēneši atpakaļ

README.md

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.

[![License](https://img.shields.io/github/license/bytedance/flowgram.ai)](https://github.com/bytedance/flowgram.ai/blob/main/LICENSE) [![@flowgram.ai/editor](https://img.shields.io/npm/dm/%40flowgram.ai%2Fcore )](https://www.npmjs.com/package/@flowgram.ai/editor)

📖 Documentation

📦 Packages

Package Description Version
@flowgram.ai/create-app App Creator npm
@flowgram.ai/fixed-layout-editor Fixed Layout Editor npm
@flowgram.ai/free-layout-editor Free Layout Editor npm

🎮 Examples

Fixed Layout

Fixed layout where nodes can be dragged to specified positions, with support for compound nodes like branches and loops.

Free Layout

Free layout where nodes can be placed anywhere and connected using free-form lines.

🚀 Getting Started

# create demo
npx @flowgram.ai/create-app@latest

# in PowerShell
npx "@flowgram.ai/create-app@latest"

# select demo
- fixed-layout # full-feature overview
- free-layout # full-feature overview
- fixed-layout-simple # basic usage
- free-layout-simple # basic usage

🔨 Development

  1. Install Node.js 18+

    nvm install lts/hydrogen
    nvm alias default lts/hydrogen # set default node version
    nvm use lts/hydrogen
    
  2. Clone the repository

    git clone git@github.com:bytedance/flowgram.ai.git
    
  3. Install required global dependencies

    npm i -g pnpm@9.12.0 @microsoft/rush@5.140.1
    
  4. Install project dependencies

    rush install
    
  5. Build the project

    rush build
    
  6. Run docs or demo

    rush dev:docs # docs
    rush dev:demo-fixed-layout
    rush dev:demo-free-layout
    

After that, you can start to develop projects inside this repository.

Enjoy it!

🌟 Contributors

FlowGram.AI Contributors

🌟 Contact us