Ei kuvausta

Louis Young 348249f1f7 feat(runtime): break & continue node (#560) 5 kuukautta sitten
.github f048f6390d fix: cli polyfill (#365) 7 kuukautta sitten
.vscode aab4183d65 feat(runtime): flowgram workflow node.js runtime (#304) 7 kuukautta sitten
apps 38ec5e8e4d feat(demo): break & continue for loop container (#559) 5 kuukautta sitten
common 758cbc355a chore: upgrade typescript (#551) 5 kuukautta sitten
config 758cbc355a chore: upgrade typescript (#551) 5 kuukautta sitten
e2e cbefaa54fb chore: add license header (#432) 6 kuukautta sitten
packages 348249f1f7 feat(runtime): break & continue node (#560) 5 kuukautta sitten
.gitattributes d7bdf8a078 feat: init flowgram.ai 10 kuukautta sitten
.gitignore 867ceb8bc2 fix(materials): json schema title & variable selector long text style (#438) 6 kuukautta sitten
CHANGELOG.md 02e48ebdd9 feat(core): add flowing field to LineColor interface (#370) 7 kuukautta sitten
CNAME e63645253a chore: add cname 10 kuukautta sitten
CONTRIBUTING.md 082321bcdb docs(readme): optimize command and version for rush setup (#396) 6 kuukautta sitten
LICENSE d7bdf8a078 feat: init flowgram.ai 10 kuukautta sitten
README.md 082321bcdb docs(readme): optimize command and version for rush setup (#396) 6 kuukautta sitten
cspell.json e5d73966b4 fix: license header autoinstall (#455) 6 kuukautta sitten
doc_build.sh cbefaa54fb chore: add license header (#432) 6 kuukautta sitten
rush.json 3f891a8a1f Revert "fix: auto llmstxt (#541)" (#545) 5 kuukautta sitten

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