# dineug/erd-editor architecture

> Architecture diagram of the GitHub repository dineug/erd-editor, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dineug/erd-editor
- Repository: https://github.com/dineug/erd-editor

## Overview

##### Main Components Architecture

The system should be divided into these major components:

a) Core Components:
- ERD Editor Engine (packages/erd-editor)
- Schema Management (packages/erd-editor-schema)
- SQL Parser (packages/schema-sql-parser)
- Custom HTML Renderer (packages/r-html)

b) Platform-specific Implementations:
- Web Application (packages/app)
- VSCode Extension (packages/vscode-extension)
- IntelliJ Plugin (packages/intellij-webview)

##### Key Architectural Elements

Frontend Architecture:
**Web Application**
- UI Components Layer
- Editor Components
- Toolbar
- Properties Panel
- State Management
- Replication Store
- Schema Store
- Services Layer
- IndexedDB Service
- Collaboration Service
- File Import/Export

Core Engine Architecture:
**ERD Editor Engine**
- Parser Layer
- SQL Parser
- Schema Parser
- Rendering Engine
- Canvas Renderer
- SVG Renderer
- Business Logic
- Table Management
- Relationship Management
- Schema Validation

##### Integration Points

Following connections:
- Data flow between components
- Communication between platform-specific implementations and core engine
- Storage mechanisms (IndexedDB, File System)
- External services integration

##### Specific Implementation Details

Technical aspects:
- Web Workers for heavy computations
- SharedWorkers for cross-tab synchronization
- WebComponents for editor embedding
- End-to-end encryption flow
- Real-time collaboration architecture

## Diagram (Mermaid)

```mermaid
graph TB
    %% Core Components
    subgraph Core["Core Components"]
        ERDEngine["ERD Editor Engine"]:::core
        SchemaManagement["Schema Management"]:::core
        SQLParser["SQL Parser"]:::core
        HTMLRenderer["Custom HTML Renderer"]:::core
    end

    %% Platform Implementations
    subgraph Platforms["Platform Implementations"]
        WebApp["Web Application"]:::platform
        VSCode["VSCode Extension"]:::platform
        IntelliJ["IntelliJ Plugin"]:::platform
    end

    %% Frontend Architecture
    subgraph Frontend["Frontend Architecture"]
        subgraph UI["UI Components"]
            Editor["Editor Components"]:::ui
            Toolbar["Toolbar"]:::ui
            Properties["Properties Panel"]:::ui
        end

        subgraph State["State Management"]
            ReplicationStore["Replication Store"]:::state
            SchemaStore["Schema Store"]:::state
        end

        subgraph Services["Services Layer"]
            IndexedDB["IndexedDB Service"]:::service
            CollabService["Collaboration Service"]:::service
            FileIO["File Import/Export"]:::service
        end
    end

    %% Core Engine Architecture
    subgraph Engine["Core Engine Architecture"]
        subgraph ParserLayer["Parser Layer"]
            SQLParserComp["SQL Parser Component"]:::engine
            SchemaParser["Schema Parser"]:::engine
        end

        subgraph RenderEngine["Rendering Engine"]
            CanvasRenderer["Canvas Renderer"]:::engine
            SVGRenderer["SVG Renderer"]:::engine
        end

        subgraph BusinessLogic["Business Logic"]
            TableMgmt["Table Management"]:::engine
            RelationshipMgmt["Relationship Management"]:::engine
            SchemaValidation["Schema Validation"]:::engine
        end
    end

    %% External Services
    ExternalDB[(External Storage)]:::external
    WebWorkers[("Web Workers")]:::external
    SharedWorkers[("Shared Workers")]:::external

    %% Relationships
    ERDEngine --> WebApp
    ERDEngine --> VSCode
    ERDEngine --> IntelliJ
    SQLParser --> ParserLayer
    SchemaManagement --> BusinessLogic
    HTMLRenderer --> RenderEngine

    WebApp --> UI
    State --> UI
    Services --> State
    IndexedDB -.-> ExternalDB
    CollabService -.-> WebWorkers
    CollabService -.-> SharedWorkers

    BusinessLogic --> RenderEngine
    ParserLayer --> BusinessLogic

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef platform fill:#4CAF50,stroke:#2E7D32,color:white
    classDef service fill:#FF9800,stroke:#EF6C00,color:white
    classDef external fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef ui fill:#03A9F4,stroke:#0277BD,color:white
    classDef state fill:#FFC107,stroke:#FFA000,color:white
    classDef engine fill:#3F51B5,stroke:#283593,color:white

    %% Click Events
    click ERDEngine "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/"
    click SchemaManagement "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor-schema/"
    click SQLParser "https://github.com/dineug/erd-editor/tree/main//packages/schema-sql-parser/"
    click HTMLRenderer "https://github.com/dineug/erd-editor/tree/main//packages/r-html/"
    click WebApp "https://github.com/dineug/erd-editor/tree/main//packages/app/"
    click VSCode "https://github.com/dineug/erd-editor/tree/main//packages/vscode-extension/"
    click IntelliJ "https://github.com/dineug/erd-editor/tree/main//packages/intellij-webview/"
    click UI "https://github.com/dineug/erd-editor/tree/main//packages/app/src/components/"
    click State "https://github.com/dineug/erd-editor/blob/main//packages/app/src/store.ts"
    click Services "https://github.com/dineug/erd-editor/tree/main//packages/app/src/services/"
    click ParserLayer "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/src/utils/schema-sql-parser/"
    click RenderEngine "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/src/components/erd/"
    click BusinessLogic "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/src/engine/"
    click SQLParserComp "https://github.com/dineug/erd-editor/tree/main//packages/schema-sql-parser/src/parser/"
    click CollabService "https://github.com/dineug/erd-editor/tree/main//packages/app/src/atoms/modules/collaborative/"
    click TableMgmt "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/src/components/erd/canvas/table/"
    click RelationshipMgmt "https://github.com/dineug/erd-editor/tree/main//packages/erd-editor/src/components/erd/canvas/canvas-svg/relationship/"
    click IndexedDB "https://github.com/dineug/erd-editor/tree/main//packages/app/src/services/indexeddb/"
    click SchemaStore "https://github.com/dineug/erd-editor/tree/main//packages/app/src/atoms/modules/schema/"
```
