# vrun-design/openflowkit architecture

> Architecture diagram of the GitHub repository vrun-design/openflowkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vrun-design/openflowkit
- Repository: https://github.com/vrun-design/openflowkit

## Overview

OpenFlowKit is a local-first visual diagramming studio, with an MCP server that exposes diagram-related capabilities to AI clients. The main user journey runs from the workspace into a canvas, where users create diagrams from templates, imports, code, or AI, refine them visually, and export them. The graph also preserves documented layout, asset, collaboration, linting, and MCP capabilities. Some subsystems are represented from README claims and the source index rather than inspected implementation; those links are documented relationships, not source-level call traces.

Main entry points: [`src/components/FlowEditor.tsx`](https://github.com/vrun-design/openflowkit/blob/main/src/components/FlowEditor.tsx) (Visual canvas), [`mcp-server/src/server.ts`](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/server.ts) (MCP tools), [`src/components/flow-editor/useFlowEditorController.ts`](https://github.com/vrun-design/openflowkit/blob/main/src/components/flow-editor/useFlowEditorController.ts) (Editor controller), [`src/components/studio-code-panel/useStudioCodePanelController.ts`](https://github.com/vrun-design/openflowkit/blob/main/src/components/studio-code-panel/useStudioCodePanelController.ts) (Diagram code)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workspace["Workspace and editing"]
  node_app["Application routes<br/>[App.tsx]"]
  node_home["Workspace home<br/>[HomePage.tsx]"]
  node_editor["Editor controller"]
  node_canvas["Visual canvas<br/>[FlowEditor.tsx]"]
end

subgraph group_creation["Diagram creation"]
  node_diagram_types["Diagram types<br/>[builtInPlugins.ts]"]
  node_import["Diagram imports"]
  node_code_panel["Diagram code"]
  node_ai["AI generation<br/>[aiService.ts]"]
end

subgraph group_refinement["Refinement and output"]
  node_layout["Graph layout<br/>[elkLayout.ts]"]
  node_icons["Icon matching<br/>[iconMatcher.ts]"]
  node_lint["Architecture rules<br/>[ruleEngine.ts]"]
  node_collaboration["Live collaboration"]
  node_export["Diagram export<br/>[exportService.ts]"]
  node_cinematic["Cinematic video<br/>[cinematicExport.ts]"]
end

subgraph group_persistence["Local-first state"]
  node_store["Workspace state"]
  node_persistence_layer[("Local persistence")]
end

subgraph group_mcp["MCP integration"]
  node_mcp_tools["MCP tools<br/>[server.ts]"]
  node_codebase["Codebase analysis<br/>[analyzeCodebase.ts]"]
  node_templates["Template catalog"]
  node_icon_catalog["Icon catalog<br/>[iconCatalog.ts]"]
  node_viewer_url["Viewer links<br/>[viewerUrl.ts]"]
end

node_user(("Diagram author"))

node_user -->|"starts at"| node_home
node_home -->|"launches editor"| node_app
node_app -->|"routes to"| node_editor
node_editor -->|"composes editor"| node_canvas
node_canvas -->|"supports types"| node_diagram_types
node_user -->|"imports diagrams"| node_import
node_user -->|"edits diagram code"| node_code_panel
node_code_panel -->|"parses Mermaid"| node_import
node_code_panel -->|"applies changes"| node_canvas
node_user -->|"requests generation"| node_ai
node_ai -->|"generates diagrams"| node_canvas
node_canvas -->|"auto-layouts"| node_layout
node_import -->|"matches technology icons"| node_icons
node_canvas -->|"checks architecture"| node_lint
node_canvas -->|"shares edits"| node_collaboration
node_canvas -->|"exports diagrams"| node_export
node_canvas -->|"renders walkthrough"| node_cinematic
node_editor -->|"manages workspace"| node_store
node_store -->|"persists state"| node_persistence_layer
node_user -->|"drives via AI client"| node_mcp_tools
node_mcp_tools -->|"registers analysis"| node_codebase
node_mcp_tools -->|"registers templates"| node_templates
node_mcp_tools -->|"registers icon search"| node_icon_catalog
node_mcp_tools -->|"registers viewer links"| node_viewer_url

click node_app "https://github.com/vrun-design/openflowkit/blob/main/src/App.tsx"
click node_home "https://github.com/vrun-design/openflowkit/blob/main/src/components/HomePage.tsx"
click node_editor "https://github.com/vrun-design/openflowkit/blob/main/src/components/flow-editor/useFlowEditorController.ts"
click node_canvas "https://github.com/vrun-design/openflowkit/blob/main/src/components/FlowEditor.tsx"
click node_diagram_types "https://github.com/vrun-design/openflowkit/blob/main/src/diagram-types/builtInPlugins.ts"
click node_import "https://github.com/vrun-design/openflowkit/blob/main/src/components/command-bar/importNativeParsers.ts"
click node_code_panel "https://github.com/vrun-design/openflowkit/blob/main/src/components/studio-code-panel/useStudioCodePanelController.ts"
click node_ai "https://github.com/vrun-design/openflowkit/blob/main/src/services/aiService.ts"
click node_mcp_tools "https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/server.ts"
click node_codebase "https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/tools/analyzeCodebase.ts"
click node_templates "https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/starterTemplates.ts"
click node_icon_catalog "https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/iconCatalog.ts"
click node_viewer_url "https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/viewerUrl.ts"
click node_layout "https://github.com/vrun-design/openflowkit/blob/main/src/services/elkLayout.ts"
click node_icons "https://github.com/vrun-design/openflowkit/blob/main/src/lib/iconMatcher.ts"
click node_lint "https://github.com/vrun-design/openflowkit/blob/main/src/services/architectureLint/ruleEngine.ts"
click node_collaboration "https://github.com/vrun-design/openflowkit/blob/main/src/services/collaboration/runtimeController.ts"
click node_export "https://github.com/vrun-design/openflowkit/blob/main/src/services/exportService.ts"
click node_cinematic "https://github.com/vrun-design/openflowkit/blob/main/src/services/export/cinematicExport.ts"
click node_store "https://github.com/vrun-design/openflowkit/blob/main/src/store/workspaceDocumentModel.ts"
click node_persistence_layer "https://github.com/vrun-design/openflowkit/blob/main/src/services/storage/flowPersistStorage.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_home,node_editor,node_canvas toneBlue
class node_diagram_types,node_import,node_code_panel,node_ai toneAmber
class node_layout,node_icons,node_lint,node_collaboration,node_export,node_cinematic toneMint
class node_store,node_persistence_layer toneRose
class node_mcp_tools,node_codebase,node_templates,node_icon_catalog,node_viewer_url,node_user toneIndigo
```

## Components

### Workspace and editing

- [Application routes](https://github.com/vrun-design/openflowkit/blob/main/src/App.tsx): `src/App.tsx`
- [Workspace home](https://github.com/vrun-design/openflowkit/blob/main/src/components/HomePage.tsx): `src/components/HomePage.tsx`
- [Editor controller](https://github.com/vrun-design/openflowkit/blob/main/src/components/flow-editor/useFlowEditorController.ts): `src/components/flow-editor/useFlowEditorController.ts`
- [Visual canvas](https://github.com/vrun-design/openflowkit/blob/main/src/components/FlowEditor.tsx): `src/components/FlowEditor.tsx`

### Diagram creation

- [Diagram types](https://github.com/vrun-design/openflowkit/blob/main/src/diagram-types/builtInPlugins.ts): `src/diagram-types/builtInPlugins.ts`
- [Diagram imports](https://github.com/vrun-design/openflowkit/blob/main/src/components/command-bar/importNativeParsers.ts): `src/components/command-bar/importNativeParsers.ts`
- [Diagram code](https://github.com/vrun-design/openflowkit/blob/main/src/components/studio-code-panel/useStudioCodePanelController.ts): `src/components/studio-code-panel/useStudioCodePanelController.ts`
- [AI generation](https://github.com/vrun-design/openflowkit/blob/main/src/services/aiService.ts): `src/services/aiService.ts`

### Refinement and output

- [Graph layout](https://github.com/vrun-design/openflowkit/blob/main/src/services/elkLayout.ts): `src/services/elkLayout.ts`
- [Icon matching](https://github.com/vrun-design/openflowkit/blob/main/src/lib/iconMatcher.ts): `src/lib/iconMatcher.ts`
- [Architecture rules](https://github.com/vrun-design/openflowkit/blob/main/src/services/architectureLint/ruleEngine.ts): `src/services/architectureLint/ruleEngine.ts`
- [Live collaboration](https://github.com/vrun-design/openflowkit/blob/main/src/services/collaboration/runtimeController.ts): `src/services/collaboration/runtimeController.ts`
- [Diagram export](https://github.com/vrun-design/openflowkit/blob/main/src/services/exportService.ts): `src/services/exportService.ts`
- [Cinematic video](https://github.com/vrun-design/openflowkit/blob/main/src/services/export/cinematicExport.ts): `src/services/export/cinematicExport.ts`

### Local-first state

- [Workspace state](https://github.com/vrun-design/openflowkit/blob/main/src/store/workspaceDocumentModel.ts): `src/store/workspaceDocumentModel.ts`
- [Local persistence](https://github.com/vrun-design/openflowkit/blob/main/src/services/storage/flowPersistStorage.ts): `src/services/storage/flowPersistStorage.ts`

### MCP integration

- [MCP tools](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/server.ts): `mcp-server/src/server.ts`
- [Codebase analysis](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/tools/analyzeCodebase.ts): `mcp-server/src/tools/analyzeCodebase.ts`
- [Template catalog](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/starterTemplates.ts): `mcp-server/src/lib/starterTemplates.ts`
- [Icon catalog](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/iconCatalog.ts): `mcp-server/src/lib/iconCatalog.ts`
- [Viewer links](https://github.com/vrun-design/openflowkit/blob/main/mcp-server/src/lib/viewerUrl.ts): `mcp-server/src/lib/viewerUrl.ts`

### Other components

- **Diagram author**

## Connections

- Diagram author → Workspace home: starts at (evidence: `README.md`)
- Workspace home → Application routes: launches editor (evidence: `src/App.tsx`)
- Application routes → Editor controller: routes to (evidence: `src/App.tsx`)
- Editor controller → Visual canvas: composes editor (evidence: `src/components/flow-editor/useFlowEditorController.ts`)
- Visual canvas → Diagram types: supports types (evidence: `README.md`)
- Diagram author → Diagram imports: imports diagrams (evidence: `README.md`)
- Diagram author → Diagram code: edits diagram code (evidence: `README.md`)
- Diagram code → Diagram imports: parses Mermaid (evidence: `src/components/studio-code-panel/useStudioCodePanelController.ts`)
- Diagram code → Visual canvas: applies changes (evidence: `src/components/studio-code-panel/useStudioCodePanelController.ts`)
- Diagram author → AI generation: requests generation (evidence: `README.md`)
- AI generation → Visual canvas: generates diagrams (evidence: `README.md`)
- Visual canvas → Graph layout: auto-layouts (evidence: `README.md`)
- Diagram imports → Icon matching: matches technology icons (evidence: `README.md`)
- Visual canvas → Architecture rules: checks architecture (evidence: `README.md`)
- Visual canvas → Live collaboration: shares edits (evidence: `README.md`)
- Visual canvas → Diagram export: exports diagrams (evidence: `README.md`)
- Visual canvas → Cinematic video: renders walkthrough (evidence: `README.md`)
- Editor controller → Workspace state: manages workspace
- Workspace state → Local persistence: persists state (evidence: `src/services/storage/flowPersistStorage.ts`)
- Diagram author → MCP tools: drives via AI client (evidence: `README.md`)
- MCP tools → Codebase analysis: registers analysis (evidence: `mcp-server/src/server.ts`)
- MCP tools → Template catalog: registers templates (evidence: `mcp-server/src/server.ts`)
- MCP tools → Icon catalog: registers icon search (evidence: `mcp-server/src/server.ts`)
- MCP tools → Viewer links: registers viewer links (evidence: `mcp-server/src/server.ts`)
