erdbpro

ERD Builder Pro

ERD Builder Pro is under active development and not yet stable — features and config may still change. Give the repo a Star and Watch it to get notified the moment a release lands.

ERD Builder Pro is a database design and documentation tool for developers. Build ERDs, flowcharts, notes, and drawings — all in one workspace.

Key Features

• Visual Workspace: ERD diagrams (XYFlow), flowcharts, free-hand drawing (Excalidraw), and rich-text notes (TipTap).
• Export: Generate SQL DDL (PostgreSQL, MySQL), export as images or PDF.
• Project Management: Organize assets into projects with soft-delete trash system.
• AI Assistant: Context-aware chat per view — generate SQL, seed data, summarize notes, create flowcharts. Streaming responses with auto-apply.
• Security: Supabase authentication, Cloudflare R2 storage, rate limiting, Helmet middleware.

Tech Stack

• Frontend: React 18 + Vite 6 + Tailwind CSS v4
• UI System: Shadcn UI + Radix UI + Lucide Icons
• Canvas Engines: XYFlow + Excalidraw
• Content Editor: TipTap (Rich Text Engine)
• Backend Architecture: Express.js + Edge Functions Support
• Infrastructure: Supabase (DB/Auth) + Cloudflare R2 (Storage)

---

Getting Started

Quick Install (Recommended)

The CLI app is the fastest way to get started — no Docker, no Supabase, no config:

npm install -g erdbpro
erdbpro

Opens at http://localhost:3101. Data stored locally in ~/.erdbpro/. Login with admin@local.dev / admin123.

A desktop app is also available on the releases page (macOS .dmg, Windows .msi, Linux .deb). Note: the desktop app is not yet code-signed — macOS and Windows may show a security warning on first launch.

Docker

docker pull bekenweb/erd-builder-pro:latest

docker run -d --name erd-builder-pro -p 3000:3000 \
  --env-file .env \
  bekenweb/erd-builder-pro:latest

Testing

The project uses Vitest for unit testing with a focus on core logic — SQL parsers, schema diff engine, auto-layout algorithms, and code generators.

Test commands:

npm test            # Run all tests once
npm run test:watch  # Run in watch mode during development

Test structure:

src/lib/__tests__/
├── sqlParser.test.ts          # SQL DDL parser (17 tests)
├── schema-diff.test.ts        # Schema comparison engine (8 tests)
├── autoLayoutERD.test.ts      # ERD auto-layout algorithm (12 tests)
├── autoLayoutFlowchart.test.ts # Flowchart auto-layout algorithm (12 tests)
├── sql-generator.test.ts      # Code generation for 7 dialects (39 tests)
└── sql-generator-all.test.ts  # Bulk export & FK extraction (19 tests)

Coverage areas: SQL DDL parsing across PostgreSQL/MySQL/SQLite dialects, schema diff & merge resolution, directed-graph auto-layout (BFS layering, cycle detection, diamond decision branching), and multi-dialect code generation (MySQL, PostgreSQL, Laravel, TypeScript, Prisma, Zod).

---

Sponsors

Sponsor	Support
IDCloudhost	Virtual machine infrastructure for deployment and cloud hosting.
Doktainer	App template platform with Docker panel for streamlined container management.

---

Support

---

License

This project is licensed under the PolyForm Noncommercial License 1.0.0.

Non-Commercial Use Only

The software is free to use, modify, and distribute for non-commercial purposes only. Any use for revenue-generating activities or within for-profit organizations is strictly prohibited under these terms.

Commercial Licensing

If you wish to use ERD Builder Pro for commercial purposes, business operations, or as part of a paid service, you must obtain a separate commercial license. Please contact the author for further information.

---

Built for Architects & Developers