# btelgeuse/greenproductive architecture

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

- Interactive diagram: https://gitdiagram.com/btelgeuse/greenproductive
- Repository: https://github.com/btelgeuse/greenproductive

## Overview

##### Project type and purpose
- This is a desktop to-do list application built with ElectronJS.
- It has three GUI “pages” (index, dashboard, finishDay), all powered by HTML/CSS/JS, plus an Electron main process to orchestrate windows and data persistence.

##### File structure
Top-level files
- package.json / package-lock.json – lists dependencies (Electron, forge) and start scripts.
- forge.config.js – controls how the app is packaged.
- main.js – the Electron entry point (“main process”).
- preload.js – the bridge between renderer and main for secure IPC.
Renderer assets
- index.html + dashboard.html + finishDay.html – the three views/UI screens.
- index.js (dashboard.js, finishDay.js) – the per-window UI logic.
- styles.css – shared styling.

##### Key insights from README
- Real-time updating to-do list, progression bar, checkpoint screens.
- No external servers or databases; state is managed in memory or filesystem via Node APIs.
- Electron handles packaging and distribution.

##### Main components
a. Electron “Main Process” (main.js)
- Creates and manages BrowserWindow instances (index, dashboard, finishDay).
- Handles IPC requests from the UIs via the preload contextBridge.
- Reads/writes any local file storage (if tasks are persisted to disk).
b. Preload Script (preload.js)
- Exposes a restricted API (via contextBridge) to each renderer.
- Marshals IPC calls (e.g. getTasks(), addTask(), completeTask()).
c. Renderer Processes (3 windows)
- index.html + index.js – initial to-do entry view.
- dashboard.html + dashboard.js – live progress overview.
- finishDay.html + finishDay.js – final achievement summary.
d. User Interface Layer
- HTML/CSS – static assets and UI components.
- JS logic updates the DOM and triggers IPC calls.
e. Operating System / File System
- Where data would be persisted (optional).
- Electron-forge packager interacts here when building installers.

##### Relationships and data flows
1. User clicks “+” in index window → index.js calls window.api.addTask(task)
2. Preload.js receives addTask IPC → forwards to main.js
3. main.js updates in-memory state (or writes a JSON file) → emits updated task list back via IPC
4. Preload.js catches the response → resolves promise to index.js → UI re-renders the list and updates the progress bar
5. Navigating to dashboard or finishDay windows repeats similar IPC for getProgress() or getSummary()

##### Architectural patterns & design principles
- Separation of concerns: Main vs Preload vs Renderer
- Single‐page GUI instances for each view, but unified state in the main process
- Secure IPC boundary via preload/contextBridge
- Modular UI scripts per page

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Main and Packaging
    subgraph "Electron Main Process"
        direction TB
        Main["Main Process"]:::main
        ForgeCfg["forge.config.js"]:::pack
        PackageJSON["package.json"]:::pack
        PackageLock["package-lock.json"]:::pack
    end

    %% Preload Layer
    Preload["Preload Script (contextBridge)"]:::preload

    %% Renderers
    subgraph "Renderer Processes"
        direction TB

        subgraph "Index Window"
            direction TB
            IDX_HTML["index.html"]:::renderer
            IDX_JS["index.js"]:::renderer
            Styles1["styles.css"]:::shared
            Assets1["assets/"]:::shared
        end

        subgraph "Dashboard Window"
            direction TB
            DB_HTML["dashboard.html"]:::renderer
            DB_JS["dashboard.js"]:::renderer
            Styles2["styles.css"]:::shared
            Assets2["assets/"]:::shared
        end

        subgraph "FinishDay Window"
            direction TB
            FD_HTML["finishDay.html"]:::renderer
            FD_JS["finishDay.js"]:::renderer
            Styles3["styles.css"]:::shared
            Assets3["assets/"]:::shared
        end
    end

    %% File System
    FS["File System"]:::filesystem

    %% Data Flows
    IDX_JS -->|"addTask()/getTasks()"| Preload
    DB_JS -->|"getProgress()"| Preload
    FD_JS -->|"getSummary()"| Preload

    Preload -->|"ipcRenderer → ipcMain"| Main
    Main -->|"read/write JSON"| FS
    FS -->|"data"| Main
    Main -->|"ipcMain → ipcRenderer"| Preload

    Preload -->|"promise resolves"| IDX_JS
    Preload -->|"promise resolves"| DB_JS
    Preload -->|"promise resolves"| FD_JS

    %% Click Events
    click Main "https://github.com/btelgeuse/greenproductive/blob/master/main.js"
    click Preload "https://github.com/btelgeuse/greenproductive/blob/master/preload.js"
    click IDX_HTML "https://github.com/btelgeuse/greenproductive/blob/master/index.html"
    click IDX_JS "https://github.com/btelgeuse/greenproductive/blob/master/index.js"
    click DB_HTML "https://github.com/btelgeuse/greenproductive/blob/master/dashboard.html"
    click DB_JS "https://github.com/btelgeuse/greenproductive/blob/master/dashboard.js"
    click FD_HTML "https://github.com/btelgeuse/greenproductive/blob/master/finishDay.html"
    click FD_JS "https://github.com/btelgeuse/greenproductive/blob/master/finishDay.js"
    click Styles1 "https://github.com/btelgeuse/greenproductive/blob/master/styles.css"
    click Styles2 "https://github.com/btelgeuse/greenproductive/blob/master/styles.css"
    click Styles3 "https://github.com/btelgeuse/greenproductive/blob/master/styles.css"
    click Assets1 "https://github.com/btelgeuse/greenproductive/tree/master/assets/"
    click Assets2 "https://github.com/btelgeuse/greenproductive/tree/master/assets/"
    click Assets3 "https://github.com/btelgeuse/greenproductive/tree/master/assets/"
    click ForgeCfg "https://github.com/btelgeuse/greenproductive/blob/master/forge.config.js"
    click PackageJSON "https://github.com/btelgeuse/greenproductive/blob/master/package.json"
    click PackageLock "https://github.com/btelgeuse/greenproductive/blob/master/package-lock.json"

    %% Styling
    classDef main fill:#D0E8FF,stroke:#005A9C,stroke-width:2px;
    classDef preload fill:#FFE5B4,stroke:#CC8400,stroke-width:2px;
    classDef renderer fill:#E6FFE6,stroke:#2E8B57,stroke-width:2px;
    classDef shared fill:#F2F2F2,stroke:#999999,stroke-width:1px;
    classDef pack fill:#FFF0F5,stroke:#C71585,stroke-width:2px;
    classDef filesystem fill:#F0F0F0,stroke:#666666,stroke-width:2px,stroke-dasharray: 5 5;
```
