Aucune description

chenjiawei.inizio 60f7ace69d chore: add memory (#306) il y a 7 mois
.github 8a6b50ba78 chore: add fixed layout node case (#294) il y a 8 mois
.vscode 8c0f007127 chore: polyfill win & eslint config fix (#192) il y a 8 mois
apps 60f7ace69d chore: add memory (#306) il y a 7 mois
common b477181502 feat(material): use tsx in cli (#295) il y a 8 mois
config ec6e5abe23 docs: free-layout-simple docs error (#245) il y a 8 mois
e2e 8a6b50ba78 chore: add fixed layout node case (#294) il y a 8 mois
packages f0d9c5062c feat(demo-fixed-layout): add case node for condition branches (#302) il y a 7 mois
.gitattributes d7bdf8a078 feat: init flowgram.ai il y a 11 mois
.gitignore 9aca28063e chore: add e2e config (#280) il y a 8 mois
CNAME e63645253a chore: add cname il y a 11 mois
CONTRIBUTING.md c21422fd20 chore: migrate to bytedance il y a 11 mois
LICENSE d7bdf8a078 feat: init flowgram.ai il y a 11 mois
README.md 95f5225660 fix: npx @flowgram.ai/form-materials cli (#203) il y a 8 mois
cspell.json 9aca28063e chore: add e2e config (#280) il y a 8 mois
doc_build.sh 60f7ace69d chore: add memory (#306) il y a 7 mois
rush.json 9aca28063e chore: add e2e config (#280) il y a 8 mois

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