mirror of
https://gitee.com/ByteDance/flowgram.ai.git
synced 2025-07-07 17:43:29 +08:00
488013bb0b
* feat(background-plugin): enhance background plugin with logo support and neumorphism effects - Add comprehensive logo support (text and image) - Implement neumorphism visual effects for modern UI - Add customizable background colors and dot patterns - Fix logo position jumping during canvas scrolling - Add complete Chinese and English documentation - Add visual examples and type definitions - Update navigation metadata for documentation Features: - Logo positioning with 5 preset locations - Neumorphism effects with configurable shadows - Custom background colors and dot styling - Smooth logo rendering during viewport changes - Comprehensive documentation with examples * fix(playground-react): fix background plugin type compatibility - Fix TypeScript error when background option is boolean - Ensure proper type handling for BackgroundLayerOptions * fix(docs): remove incorrect number from sub-canvas plugin heading --------- Co-authored-by: husky-dot <xiaozhi@172-0-8-36.lightspeed.rcsntx.sbcglobal.net>
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.
📖 Documentation
📦 Packages
| Package | Description | Version |
|---|---|---|
| @flowgram.ai/create-app | App Creator |  |
| @flowgram.ai/fixed-layout-editor | Fixed Layout Editor |  |
| @flowgram.ai/free-layout-editor | Free Layout Editor |  |
🎮 Examples
Fixed layout where nodes can be dragged to specified positions, with support for compound nodes like branches and loops.
🚀 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
- Install Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen
- Clone the repository
git clone git@github.com:bytedance/flowgram.ai.git
- Install required global dependencies
npm i -g pnpm@9.12.0 @microsoft/rush@5.140.1
- Install project dependencies
rush install
- Build the project
rush build
- 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
🌟 Contact us
- Issues: Issues
- Lark: Scan the QR code below with Register Feishu to join our FlowGram user group.
