@flowdrop/flowdrop
v1.2.2
Published
A drop-in visual workflow editor for any web application. You own the backend. You own the data. You own the orchestration.
Downloads
524
Maintainers
Readme
Why FlowDrop?
Most workflow tools are SaaS platforms that lock you in. Your data lives on their servers. Your execution logic runs in their cloud. You pay per workflow, per user, per run.
FlowDrop is different.
FlowDrop is a pure visual editor. You implement the backend. You control the orchestration. Your workflows run on your infrastructure, with your security policies, at your scale.
No vendor lock-in. No data leaving your walls. No surprise bills.
npm install @flowdrop/flowdropNote: FlowDrop supports one editor instance per page (module-level singleton stores). See Architecture Notes for details.
You get a production-ready workflow UI. You keep full control of everything else.
Quickstart
<script lang="ts">
import { WorkflowEditor } from "@flowdrop/flowdrop";
import "@flowdrop/flowdrop/styles/base.css";
</script>
<WorkflowEditor />5 lines. One fully-functional workflow editor.
Features
| | | | ---------------------------- | ------------------------------------------------------------------------- | | 🎨 Visual Editor Only | Pure UI component. No hidden backend, no external dependencies | | 🔐 You Own Everything | Your data, your servers, your orchestration logic, your security policies | | 🔌 Backend Agnostic | Connect to any API: Drupal, Laravel, Express, FastAPI, or your own | | 🧩 7 Built-in Node Types | From simple icons to complex gateway logic | | 🎭 Framework Flexible | Use as Svelte component or mount into React, Vue, Angular, or vanilla JS | | 🐳 Deploy Anywhere | Runtime config means build once, deploy everywhere |
Architecture Notes
- Single instance per page. FlowDrop uses module-level singleton stores for state management. Only one FlowDrop editor instance can exist on a page at a time.
- Svelte 5 required. FlowDrop uses Svelte 5 runes (
$state,$derived,$effect) throughout. Svelte 4 is not supported. - Modern browsers only. The library targets ES2020+ and does not include polyfills for older browsers.
Node Types
FlowDrop ships with 7 beautifully designed node types:
| Type | Purpose |
| ---------- | --------------------------------------- |
| default | Full-featured nodes with inputs/outputs |
| simple | Compact, space-efficient layout |
| square | Icon-only minimal design |
| tool | AI agent tool nodes |
| gateway | Conditional branching logic |
| terminal | Start/end workflow points |
| note | Markdown documentation blocks |
Integration
Svelte (Native)
<script>
import { WorkflowEditor, NodeSidebar } from "@flowdrop/flowdrop";
</script>
<div class="flex h-screen">
<NodeSidebar {nodes} />
<WorkflowEditor {nodes} />
</div>Vanilla JS / React / Vue / Angular
import { mountFlowDropApp, createEndpointConfig } from "@flowdrop/flowdrop";
const app = await mountFlowDropApp(document.getElementById("editor"), {
workflow: myWorkflow,
endpointConfig: createEndpointConfig("/api/flowdrop"),
eventHandlers: {
onDirtyStateChange: (isDirty) => console.log("Unsaved changes:", isDirty),
onAfterSave: (workflow) => console.log("Saved!", workflow),
},
});
// Full control over the editor
app.save();
app.getWorkflow();
app.destroy();Enterprise Integration
import { mountFlowDropApp, CallbackAuthProvider } from "@flowdrop/flowdrop";
const app = await mountFlowDropApp(container, {
// Dynamic token refresh
authProvider: new CallbackAuthProvider({
getToken: () => authService.getAccessToken(),
onUnauthorized: () => authService.refreshToken(),
}),
// Lifecycle hooks
eventHandlers: {
onBeforeUnmount: (workflow, isDirty) => {
if (isDirty) saveDraft(workflow);
},
},
// Auto-save, toasts, and more
features: {
autoSaveDraft: true,
autoSaveDraftInterval: 30000,
},
});API Configuration
Connect to any backend in seconds:
import { createEndpointConfig } from "@flowdrop/flowdrop";
const config = createEndpointConfig({
baseUrl: "https://api.example.com",
endpoints: {
nodes: { list: "/nodes", get: "/nodes/{id}" },
workflows: {
list: "/workflows",
get: "/workflows/{id}",
create: "/workflows",
update: "/workflows/{id}",
execute: "/workflows/{id}/execute",
},
},
auth: { type: "bearer", token: "your-token" },
});Customization
Make it yours with CSS custom properties:
:root {
--flowdrop-background-color: #0a0a0a;
--flowdrop-primary-color: #6366f1;
--flowdrop-border-color: #27272a;
--flowdrop-text-color: #fafafa;
}Deploy
Docker (Recommended)
cd ../../apps/example-client-docker
cp env.example .env
docker-compose up -dNode.js
npm run build
FLOWDROP_API_BASE_URL=http://your-backend/api node buildRuntime configuration means you build once and deploy to staging, production, or anywhere else with just environment variables.
Documentation
| Resource | Description | | ------------------------------------------------------------ | ------------------------ | | API Documentation | REST API specification | | Docker Guide | Docker deployment guide | | QUICK_START.md | Get running in 5 minutes | | CHANGELOG.md | Version history |
Development
pnpm install # Install dependencies
pnpm dev # Start dev server
pnpm build # Build library
pnpm test # Run all testsContributing
FlowDrop is stabilizing. Contributions will open soon. Star the repo to stay updated.
