# vishalla/mathai-v2 architecture

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

- Interactive diagram: https://gitdiagram.com/vishalla/mathai-v2
- Repository: https://github.com/vishalla/mathai-v2

## Overview

##### Project Type and Purpose
- This is a standalone JavaFX desktop application (MathAI_GUI) for organizing and editing “documents,” “notebooks,” and “folders,” with a responsive GUI built using FXML views and CSS styles. Data is persisted locally as JSON files.

##### Key Architectural Layers
a. Presentation Layer (UI)
- FXML Views (MathAI_GUI/src/view/*.fxml)
- CSS Stylesheets (MathAI_GUI/src/styles/*.css)
- Images (MathAI_GUI/src/images/)
b. Controller Layer (MVC Controllers)
- Scene Controllers under src/controllers (Home, Favorites, Trash, NotebookEditor, itemControllers, etc.)
- A base Controllerabstract.java and shared TriConsumer event handler
c. Domain & Utility Layer
- StorageManager.java: handles all JSON file I/O under MathAI_GUI/data/
- ThemeManager.java: applies and switches UI themes via CSS
d. Application / Entry Point
- Main.java: Application.launch, initializes primary scene
- Test.java: auxiliary startup/test harness
e. Data Layer
- Local JSON files for documents, notebooks, folders (MathAI_GUI/data/**/*.json)
- index.json for file indexing

##### Interactions and Data Flow
- User actions in the GUI (button clicks, menu selections) → Controller methods
- Controllers update the View (via FXMLLoader, injecting model data into UI controls)
- Controllers call StorageManager to read/write JSON files → local filesystem
- ThemeManager invoked by controllers to switch CSS on active Scene
- Application entry point (Main) wires together initial Scene, loads Home.fxml

##### Architectural Patterns
- Model-View-Controller: clear separation between FXML views (View), Controllers (Controller), and JSON-backed models (Model via StorageManager)
- Layered architecture: UI → Controllers → Utilities → Data storage
- Single process monolith; no external services

- Frontend/UI Module
- View files (FXML)
- CSS styles
- Images
- Controller Module
- Scene controllers
- Item controllers (DocumentItemController, FolderItemController, etc.)
- Utility Module
- StorageManager (JSON I/O)
- ThemeManager (CSS management)
- Data Store
- Local filesystem JSON directory (data/)
- Application Layer
- Main.java

##### Essential Elements
- Component names matching actual directories/files (e.g., NotebookEditorController)
- Data storage structure (folders and JSON files)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Application Entry Point
    subgraph "Application Entry Point"
        Main["Main.java"]:::entry
        Test["Test.java"]:::entry
    end

    %% Presentation Layer (UI)
    subgraph "Presentation Layer"
        FXML["FXML Views"]:::ui
        CSS["CSS Stylesheets"]:::ui
        Images["Images"]:::ui
    end

    %% Controller Layer
    subgraph "Controller Layer"
        BaseController["Controllerabstract.java"]:::controllers
        TriConsumer["TriConsumer.java"]:::controllers

        subgraph "Home Controllers"
            HomeScene["HomeScene.java"]:::controllers
            ItemOpenEvent["ItemOpenEvent.java"]:::controllers
        end

        FavoritesScene["FavoritesScene.java"]:::controllers
        TrashScene["TrashScene.java"]:::controllers

        subgraph "Notebook Editor Controllers"
            NotebookEditorController["NotebookEditorController.java"]:::controllers
            NotebookEditorSettingsController["NotebookEditorSettingsController.java"]:::controllers
            PageController["PageController.java"]:::controllers
        end

        subgraph "Item Controllers"
            BaseItemController["BaseItemController.java"]:::controllers
            DocumentItemController["DocumentItemController.java"]:::controllers
            FolderItemController["FolderItemController.java"]:::controllers
            NotebookItemController["NotebookItemController.java"]:::controllers
        end
    end

    %% Utility Module
    subgraph "Utility Module"
        StorageManager["StorageManager.java"]:::utils
        ThemeManager["ThemeManager.java"]:::utils
    end

    %% Data Store
    subgraph "Data Store"
        DocumentsJSON["Documents JSON"]:::datastore
        NotebooksJSON["Notebooks JSON"]:::datastore
        FoldersJSON["Folders JSON"]:::datastore
        IndexFile["index.json"]:::datastore
    end

    %% User Actor
    User((User))

    %% Relationships
    User -->|"interacts with"| FXML
    FXML -->|"load FXML"| HomeScene
    FXML -->|"load FXML"| FavoritesScene
    FXML -->|"load FXML"| TrashScene
    FXML -->|"load FXML"| NotebookEditorController

    HomeScene -->|"uses BaseController & events"| BaseController
    HomeScene -->|"uses TriConsumer event handler"| TriConsumer
    HomeScene -->|"opens items"| ItemOpenEvent

    FavoritesScene -->|"extends BaseController"| BaseController
    TrashScene -->|"extends BaseController"| BaseController

    NotebookEditorController -->|"manages notebook UI"| PageController
    NotebookEditorController -->|"manages settings UI"| NotebookEditorSettingsController

    DocumentItemController -->|"extends BaseItemController"| BaseItemController
    FolderItemController -->|"extends BaseItemController"| BaseItemController
    NotebookItemController -->|"extends BaseItemController"| BaseItemController

    HomeScene -->|"invokes"| StorageManager
    FavoritesScene -->|"invokes"| StorageManager
    TrashScene -->|"invokes"| StorageManager
    NotebookEditorController -->|"invokes"| StorageManager
    DocumentItemController -->|"invokes"| StorageManager

    StorageManager -->|"read/write JSON"| DocumentsJSON
    StorageManager -->|"read/write JSON"| NotebooksJSON
    StorageManager -->|"read/write JSON"| FoldersJSON
    StorageManager -->|"read/write JSON"| IndexFile

    HomeScene -->|"apply theme"| ThemeManager
    FavoritesScene -->|"apply theme"| ThemeManager
    TrashScene -->|"apply theme"| ThemeManager
    NotebookEditorController -->|"apply theme"| ThemeManager

    ThemeManager -->|"updates CSS"| CSS

    Main -->|"initializes"| HomeScene
    Main -->|"launches app"| FXML

    %% Click Events
    click FXML "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/src/view/"
    click CSS "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/src/styles/"
    click Images "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/src/images/"
    click BaseController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/Controllerabstract.java"
    click TriConsumer "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/TriConsumer.java"
    click HomeScene "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/HomeControllers/HomeScene.java"
    click ItemOpenEvent "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/HomeControllers/ItemOpenEvent.java"
    click FavoritesScene "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/FavoritesControllers/FavoritesScene.java"
    click TrashScene "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/TrashControllers/TrashScene.java"
    click NotebookEditorController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/Notebookeditor/NotebookEditorController.java"
    click NotebookEditorSettingsController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/Notebookeditor/NotebookEditorSettingsController.java"
    click PageController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/Notebookeditor/PageController.java"
    click BaseItemController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/itemController/BaseItemController.java"
    click DocumentItemController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/itemController/DocumentItemController.java"
    click FolderItemController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/itemController/FolderItemController.java"
    click NotebookItemController "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/controllers/itemController/NotebookItemController.java"
    click StorageManager "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/utils/StorageManager.java"
    click ThemeManager "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/utils/ThemeManager.java"
    click Main "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/application/Main.java"
    click Test "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/src/application/Test.java"
    click DocumentsJSON "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/data/documents/"
    click NotebooksJSON "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/data/notebooks/"
    click FoldersJSON "https://github.com/vishalla/mathai-v2/tree/main/MathAI_GUI/data/folders/"
    click IndexFile "https://github.com/vishalla/mathai-v2/blob/main/MathAI_GUI/data/index.json"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#000;
    classDef controllers fill:#FFA500,stroke:#000;
    classDef utils fill:#90EE90,stroke:#000;
    classDef datastore fill:#D3D3D3,stroke:#000;
    classDef entry fill:#9370DB,stroke:#000;
```
