openflowkit  by Vrun-design

Local-first AI diagramming for architecture and flowcharts

Created 4 months ago
597 stars

Top 54.1% on SourcePulse

GitHubView on GitHub
Project Summary

OpenFlowKit is a free, open-source, local-first AI diagramming studio designed for creating architecture diagrams and flowcharts. It targets builders, engineers, and power users, offering a developer-centric approach that combines visual editing with code-based generation, AI assistance, and unique animated exports, all without requiring server-side storage or user accounts.

How It Works

The core of OpenFlowKit lies in its bidirectional "diagram-as-code" (DSL) functionality, allowing seamless synchronization between a visual canvas and a code panel using Mermaid-compatible syntax. It integrates AI generation from nine different providers with a bring-your-own-key (BYOK) model, and automatically assigns over 1,600 technology icons from various catalogs (AWS, Azure, GCP, CNCF) based on node labels. A standout feature is its browser-native "cinematic" export, generating animated video walkthroughs of diagrams.

Quick Start & Requirements

To get started, clone the repository, install dependencies, and run the development server:

git clone https://github.com/Vrun-design/openflowkit.git
cd openflowkit
npm install
npm run dev

The application runs locally at http://localhost:5173. No environment variables are required for basic setup; AI provider keys are configured in-app at runtime.

Highlighted Details

  • Cinematic Export: Generates animated WebM/MP4 videos of diagram creation directly in the browser, a unique feature among open-source tools.
  • AI Generation (Flowpilot): Supports 9 providers (Google Gemini, OpenAI, Anthropic Claude, etc.) with BYOK, allowing diagram creation from natural language descriptions or code.
  • Auto-Icon Assignment: Automatically matches over 1,600 branded icons (AWS, Azure, GCP, CNCF, developer) to diagram nodes based on labels, eliminating manual placement.
  • Bidirectional Diagram-as-Code: Live, two-way synchronization between the visual editor and a Mermaid-compatible DSL.
  • Local-First Architecture: Operates entirely client-side using IndexedDB for storage, requiring no account or server-side data handling.
  • P2P Collaboration (Beta): Enables real-time collaboration via WebRTC without a mandatory backend server.

Maintenance & Community

The project is actively developed with a roadmap focusing on GIF export, GitHub repo-to-diagram conversion (currently in beta), enhanced layer/page workflows, and performance improvements. Contributions are welcomed, with specific "good first issues" tagged.

Licensing & Compatibility

OpenFlowKit is released under the permissive MIT license. Its local-first, client-side nature ensures no vendor lock-in and makes it highly compatible for integration into various workflows, including commercial use, without server-side dependencies.

Limitations & Caveats

Real-time collaboration and the GitHub repo-to-diagram feature are currently in beta. The tool focuses on structured diagram types rather than freeform whiteboarding.

Health Check
Last Commit

6 days ago

Responsiveness

Inactive

Pull Requests (30d)
4
Issues (30d)
1
Star History
127 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.