Apitomy Flow
Lightweight visual workflow engine for orchestrating long-running project lifecycles.
Apitomy Flow is a standalone library designed to integrate into Apitomy products. It provides a stateless workflow execution engine (Java) and a visual drag-and-drop editor (React) for defining and monitoring workflows.
Key Features
- Directed graph workflows with 6 node types and conditional edge routing
- Stateless engine — takes state in, returns state out; no persistence opinions
- Human-in-the-loop tasks and external event correlation
- Visual editor with drag-and-drop node placement and real-time validation
- Read-only viewer for monitoring workflow instance progress
- 55 validation rules catch structural and semantic problems at design time
Two Components
| Component | Technology | Purpose |
|---|---|---|
| Engine | Java 21, pure library | Workflow execution, validation, event correlation |
| Visual Editor | React 19, TypeScript | WorkflowEditor and WorkflowViewer components |
The engine has no framework dependencies — it works in any Java application. The visual editor is a React component library that consuming applications import and render.
Getting Started
- Installation — Maven coordinates and npm package
- Quick Start — Run your first workflow in minutes
User Guide
- Workflow Model — nodes, edges, and instances
- Engine Usage — running and resuming workflows with
WorkflowEngine - Node Executors — implementing action nodes
- Error Handling — fail / retry / transition strategies
- Event Correlation — matching external events to waiting instances
- Validation — the validation rules reference
- Visual Editor — the
WorkflowEditorcomponent - Workflow Viewer — the
WorkflowViewercomponent - Parallel Fork/Join — a worked fork/join workflow
Developer Guide
- Architecture — engine and UI internals
- Building — build from source and run the dev app
- Contributing — contribution workflow
Links
- GitHub Repository
- Apitomy Website
- Apitomy Axiom — the first product integrating Flow