# weiwenda/effect-note architecture

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

- Interactive diagram: https://gitdiagram.com/weiwenda/effect-note
- Repository: https://github.com/weiwenda/effect-note

## Overview

##### Main Components Overview

a. Core Application Layers:
- Frontend (React-based UI)
- Backend Services (Electron + Express)
- Storage Layer (File-based + Git sync)

b. Key Features:
- Document Management
- Drawing/Diagramming (DrawIO integration)
- Mind Mapping
- PDF Processing
- Git Synchronization

##### Detailed Component Breakdown

Frontend Layer:

- React Frontend     |

- Components          |
- Editor            |
- Mindmap           |
- DrawIO Editor     |
- PDF Converter     |
- Plugins System      |
- State Management    |

Backend Services:

- Electron Backend     |

- File System Access   |
- Git Integration      |
- Express Server       |
- Data Backends       |

Storage & Sync:

- Storage System      |

- Local File Storage   |
- Git Repository      |
- Cloud Sync          |

##### Integration Points

- Frontend components and backend services
- Backend services and storage system
- Git sync system and cloud storage

##### Key Technologies to Highlight

Technology labels in appropriate sections:
- React
- Electron
- Express
- Isomorphic-git
- DrawIO
- KittyMinder
- Monaco Editor
- Vditor

##### Data Flow

**User Interface → Backend Services → Storage**
**↑                                    ↓**
- Git Sync System ─────────┘

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Frontend
        UI[React Frontend]
        Editor[Editor Components]
        MM[Mind Map]
        DIO[DrawIO Integration]
        PDF[PDF Processing]
        Plugins[Plugin System]
        State[State Management]
    end

    subgraph Backend
        EB[Electron Backend]
        ES[Express Server]
        FSA[File System Access]
        GI[Git Integration]
        DB[Data Backends]
    end

    subgraph Storage
        LS[Local Storage]
        GR[Git Repository]
        CS[Cloud Sync]
    end

    %% Frontend Connections
    UI --> Editor
    UI --> MM
    UI --> DIO
    UI --> PDF
    UI --> Plugins
    UI --> State

    %% Backend Connections
    EB --> ES
    EB --> FSA
    EB --> GI
    EB --> DB

    %% Cross-layer Connections
    Frontend --> Backend
    Backend --> Storage
    GI --> CS
    CS --> GR

    %% Component Mappings
    click EB "https://github.com/WeiWenda/effect-note/blob/master/main/electron.js"
    click ES "https://github.com/WeiWenda/effect-note/blob/master/main/prod.js"
    click FSA "https://github.com/WeiWenda/effect-note/blob/master/main/expressDocCurd.js"
    click GI "https://github.com/WeiWenda/effect-note/blob/master/main/isomorphicGit.js"
    click DB "https://github.com/WeiWenda/effect-note/blob/master/server/data_backends.ts"
    click DIO "https://github.com/WeiWenda/effect-note/tree/master/public/drawio/"
    click MM "https://github.com/WeiWenda/effect-note/blob/master/src/components/mindmap.js"
    click PDF "https://github.com/WeiWenda/effect-note/tree/master/src/components/pdf-to-markdown/"
    click Plugins "https://github.com/WeiWenda/effect-note/tree/master/src/plugins/"
    click UI "https://github.com/WeiWenda/effect-note/tree/master/src/components/layout/"

    %% Styling
    classDef frontend fill:#a8d1ff,stroke:#333,stroke-width:2px
    classDef backend fill:#90EE90,stroke:#333,stroke-width:2px
    classDef storage fill:#FFB347,stroke:#333,stroke-width:2px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:2px

    class UI,Editor,MM,DIO,PDF,Plugins,State frontend
    class EB,ES,FSA,GI,DB backend
    class LS,GR,CS storage

    %% Legend
    subgraph Legend
        FE[Frontend]:::frontend
        BE[Backend]:::backend
        ST[Storage]:::storage
        EX[External]:::external
    end
```
