# n-ziermann-youtube/electron-course architecture

> Architecture diagram of the GitHub repository n-ziermann-youtube/electron-course, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/n-ziermann-youtube/electron-course
- Repository: https://github.com/n-ziermann-youtube/electron-course

## Overview

##### Project Type and Purpose
- This is a desktop full-stack application built with Electron.
- Purpose: display system resource usage (CPU, RAM, FS) in a React/TypeScript UI, with IPC, tray/hide functionality, and custom menus.

##### File Structure
- src/electron: Electron “main” process code
- main.ts – app lifecycle, window creation
- preload.cts – contextBridge setup for IPC
- menu.ts – custom menu bar definitions
- tray.ts / tray.test.ts – system tray behavior and tests
- resourceManager.ts – system metrics retrieval
- pathResolver.ts, util.ts – file paths, utility functions
- src/ui: Renderer process (React)
- main.tsx – UI entry point
- App.tsx, Chart.tsx, BaseChart.tsx – React components displaying metrics
- useStatistics.ts – custom hook fetching data via IPC
- assets/, CSS files – styling and static resources
- Config & Build
- vite.config.ts – renderer build pipeline
- electron-builder.json – packaging settings
- tsconfig*.json – TypeScript configuration
- Testing
- e2e/example.spec.ts + playwright.config.ts – end-to-end tests
- Vitest (implicitly via package.json) for unit tests

##### Extract Architectural Insights from README
- Emphasizes typesafe IPC, hide-to-tray, custom menu, custom window frame.
- Testing via Playwright and Vitest.

##### Main Components
a. Electron Main Process
- Window Manager (main.ts)
- Tray & Menu Controller (tray.ts, menu.ts)
- Resource Manager Service (resourceManager.ts)
- Preload Script (preload.cts) exposing IPC channels
b. Renderer Process (React App)
- UI Components (App, Chart, BaseChart)
- Data-fetching Hook (useStatistics)
- Static Assets & Styles
c. IPC Channel (Type-safe communication)
d. OS APIs / System Libraries
- Node os/fs modules invoked by resourceManager
e. Build & Packaging
- Vite bundler for renderer
- electron-builder for packaging
f. Testing Frameworks
- Playwright (E2E)
- Vitest (Unit)

##### Relationships and Interactions
- Window Manager → Launches BrowserWindow → Loads React bundle
- Renderer ↔ Main via IPC channels (e.g., “get-stats” request, “stats-response”)
- Resource Manager polls OS APIs → returns data to Main → forwards to Renderer
- Tray & Menu emit events (click/hide) → Main adjusts window visibility
- Preload script registers secure IPC handlers for use by useStatistics
- Build tools: Vite compiles src/ui → dist; electron-builder packages main & dist into installer

##### Architectural Patterns
- Separation of Concerns: Main vs. Renderer
- Publisher/Subscriber or Request/Response via IPC
- MVC-style: ResourceManager (Model), IPC (Controller), React UI (View)
- Module encapsulation: utilities, pathResolver, menu definitions separated

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Electron Main Process
    subgraph "Electron Main Process"
        WManager["Window Manager\n(main.ts)"]:::main
        TrayCtrl["Tray Controller\n(tray.ts)"]:::main
        MenuCtrl["Menu Controller\n(menu.ts)"]:::main
        ResourceMgr["Resource Manager\n(resourceManager.ts)"]:::service
        Preload["Preload Script\n(preload.cts)"]:::main
        PathResolver["Path Resolver\n(pathResolver.ts)"]:::util
        Util["Utilities\n(util.ts)"]:::util
    end

    %% Renderer Process
    subgraph "Renderer Process (React UI)"
        Entry["UI Entry Point\n(main.tsx)"]:::renderer
        RootComp["App Component\n(App.tsx)"]:::renderer
        ChartComp1["Chart Component\n(Chart.tsx)"]:::renderer
        ChartComp2["Base Chart\n(BaseChart.tsx)"]:::renderer
        Hook["Data-Fetching Hook\n(useStatistics.ts)"]:::renderer
        Style1["Global CSS\n(index.css)"]:::assets
        Style2["App CSS\n(App.css)"]:::assets
        Assets["Static Assets\n(assets/)"]:::assets
    end

    %% OS APIs
    subgraph "OS APIs & File System"
        OS["Node os/fs Modules"]:::os
    end

    %% Build & Packaging
    subgraph "Build & Packaging"
        Vite["Vite Config\n(vite.config.ts)"]:::build
        Builder["Electron Builder\n(electron-builder.json)"]:::build
        TSConfig["TypeScript Configs\n(tsconfig.json, tsconfig.node.json,\nsrc/electron/tsconfig.json)"]:::build
    end

    %% Testing
    subgraph "Testing Frameworks"
        E2E["Playwright E2E\n(e2e/example.spec.ts)"]:::test
        E2EConfig["Playwright Config\n(playwright.config.ts)"]:::test
        Unit["Vitest Unit Tests\n(tray.test.ts)"]:::test
    end

    %% Relationships
    WManager -->|"Creates BrowserWindow\nLoads bundle"| Entry
    Entry -->|Renders| RootComp
    RootComp -->|Uses| ChartComp1
    RootComp -->|Uses| ChartComp2
    RootComp -->|Calls| Hook
    Hook -->|"invoke('getStats')"| Preload
    Preload -->|"ipc invoke getStats"| ResourceMgr
    ResourceMgr -->|Reads| OS
    ResourceMgr -->|Returns stats| Preload
    Preload -->|"send('stats-response')"| Hook
    TrayCtrl -->|Tray events| WManager
    MenuCtrl -->|Menu events| WManager
    PathResolver -->|Helper for| ResourceMgr
    Util -->|Utilities for| ResourceMgr
    Vite -->|Bundles Renderer| Entry
    Builder -->|Packages Main & Renderer| WManager
    TSConfig -.->|Typesafety| WManager
    TSConfig -.->|Typesafety| Entry
    E2E -->|Tests App| WManager
    E2E -->|Tests UI| Entry
    Unit -->|Tests| TrayCtrl

    %% Click Events
    click WManager "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/main.ts"
    click TrayCtrl "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/tray.ts"
    click MenuCtrl "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/menu.ts"
    click ResourceMgr "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/resourceManager.ts"
    click Preload "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/preload.cts"
    click PathResolver "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/pathResolver.ts"
    click Util "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/util.ts"
    click Entry "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/main.tsx"
    click RootComp "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/App.tsx"
    click ChartComp1 "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/Chart.tsx"
    click ChartComp2 "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/BaseChart.tsx"
    click Hook "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/useStatistics.ts"
    click Style1 "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/index.css"
    click Style2 "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/ui/App.css"
    click Assets "https://github.com/n-ziermann-youtube/electron-course/tree/main/src/ui/assets"
    click Vite "https://github.com/n-ziermann-youtube/electron-course/blob/main/vite.config.ts"
    click Builder "https://github.com/n-ziermann-youtube/electron-course/blob/main/electron-builder.json"
    click E2E "https://github.com/n-ziermann-youtube/electron-course/blob/main/e2e/example.spec.ts"
    click E2EConfig "https://github.com/n-ziermann-youtube/electron-course/blob/main/playwright.config.ts"
    click Unit "https://github.com/n-ziermann-youtube/electron-course/blob/main/src/electron/tray.test.ts"

    %% Styling
    classDef main fill:#cce5ff,stroke:#004085,color:#004085
    classDef renderer fill:#d4edda,stroke:#155724,color:#155724
    classDef service fill:#fff3cd,stroke:#856404,color:#856404
    classDef util fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef os fill:#f8d7da,stroke:#721c24,color:#721c24
    classDef build fill:#f5c6cb,stroke:#721c24,color:#721c24,stroke-dasharray: 5 5
    classDef test fill:#e2f0fd,stroke:#0c5460,color:#0c5460,stroke-dasharray: 2 2
    classDef assets fill:#fff5e6,stroke:#856404,color:#856404
```
