Sin descripción

xiamidaxia 77d8a893cb feat(docs): add custom layer docs (#383) hace 6 meses
.github f048f6390d fix: cli polyfill (#365) hace 7 meses
.vscode aab4183d65 feat(runtime): flowgram workflow node.js runtime (#304) hace 7 meses
apps 77d8a893cb feat(docs): add custom layer docs (#383) hace 6 meses
common 39734e5a02 refactor: i18n (#374) hace 7 meses
config ec6e5abe23 docs: free-layout-simple docs error (#245) hace 7 meses
e2e c320ab61e9 feat(demo-fixed-layout): update initialData (#341) hace 7 meses
packages fd423d9cb5 feat(minimap): support touch operation (#381) hace 7 meses
.gitattributes d7bdf8a078 feat: init flowgram.ai hace 10 meses
.gitignore 9aca28063e chore: add e2e config (#280) hace 7 meses
CHANGELOG.md 02e48ebdd9 feat(core): add flowing field to LineColor interface (#370) hace 7 meses
CNAME e63645253a chore: add cname hace 10 meses
CONTRIBUTING.md c21422fd20 chore: migrate to bytedance hace 10 meses
LICENSE d7bdf8a078 feat: init flowgram.ai hace 10 meses
README.md 95f5225660 fix: npx @flowgram.ai/form-materials cli (#203) hace 8 meses
cspell.json 9d029bf335 feat(auto-layout): support custom layout config (#378) hace 7 meses
doc_build.sh 60f7ace69d chore: add memory (#306) hace 7 meses
rush.json da78b36fd1 feat: Add demo-nextjs-antd demo and free-antd-materials package (#366) hace 7 meses

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/dw/%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.0
    
  4. Install project dependencies

    rush update
    
  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!

Stats

Repo Stats

🌟 Contributors

FlowGram.AI Contributors

🌟 Contact us