# normancao2702/cmpt213-asgn5-courseplanner architecture

> Architecture diagram of the GitHub repository normancao2702/cmpt213-asgn5-courseplanner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/normancao2702/cmpt213-asgn5-courseplanner
- Repository: https://github.com/normancao2702/cmpt213-asgn5-courseplanner

## Overview

##### Project type and purpose
- This is a full-stack web application (“Course Planner”) built with Spring Boot.
- Purpose: load term/course data from CSV files into an in-memory model, expose REST endpoints for browsing courses, departments, offerings, watchers, stats, and serve a static JavaScript/HTML UI under “public.”

##### File structure
- Top-level
- build.gradle / gradlew* / gradle/… → standard Gradle/Spring Boot build
- src/main/java/ca/cmpt213/courseplanner → back-end code
- public → front-end static assets (HTML, CSS, JS)
- data → CSV files as the data source
- docs → curl examples and sample outputs
- Within src/main/java:
- controllers package → REST controllers (About, Department, CourseOffering, Stats, Watcher, DumpModel)
- dto package → Data Transfer Objects shaping JSON responses
- models package → domain classes (Department, Course, CourseOffering, Section, Watcher) and central ModelManager
- utils package → CSVDataProcessor, CSVReader, TermCodeConverter for data ingestion

##### README insights
- Five stages: project setup, core model, basic API, advanced watcher/stats features, testing
- Confirms MVC structure: models loaded via utils → controllers expose API → static UI calls those endpoints

##### Detail
- DTO translation step between model and HTTP response

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend UI"
        Browser["Browser"]:::frontend
        subgraph "Static Assets"
            Index["index.html"]:::frontend
            AboutPage["about.html"]:::frontend
            GraphPage["graph.html"]:::frontend
            WatchersPage["watchers.html"]:::frontend
            CSS["css/"]:::frontend
            Scripts["scripts/"]:::frontend
        end
    end

    %% Backend Application
    subgraph "Spring Boot Application"
        App["CoursePlannerApplication"]:::backend

        subgraph "Static Resource Handler"
            Handler["StaticResourceHandler"]:::backend
        end

        subgraph "REST API Layer"
            AboutCtrl["AboutController"]:::controller
            DeptCtrl["DepartmentController"]:::controller
            OfferCtrl["OfferingController"]:::controller
            WatcherCtrl["WatcherController"]:::controller
            StatsCtrl["StatsController"]:::controller
            DumpCtrl["DumpModelController"]:::controller
        end

        subgraph "Service / Business Layer"
            ModelMgr["ModelManager"]:::service
            subgraph "Data Ingestion Utils"
                CSVReader["CSVReader"]:::util
                CSVProcessor["CSVDataProcessor"]:::util
                TermConv["TermCodeConverter"]:::util
            end
        end

        subgraph "Domain Models"
            Dept["Department"]:::model
            Course["Course"]:::model
            CourseOff["CourseOffering"]:::model
            Section["Section"]:::model
            WatcherModel["Watcher"]:::model
        end

        subgraph "DTO Layer"
            AboutDTO["ApiAboutDTO"]:::dto
            DeptDTO["ApiDepartmentDTO"]:::dto
            CourseDTO["ApiCourseDTO"]:::dto
            CourseOffDTO["ApiCourseOfferingDTO"]:::dto
            OfferingSecDTO["ApiOfferingSectionDTO"]:::dto
            OfferingDataDTO["ApiOfferingDataDTO"]:::dto
            WatcherDTO["ApiWatcherDTO"]:::dto
            WatcherCreateDTO["ApiWatcherCreateDTO"]:::dto
            GraphDTO["ApiGraphDataPointDTO"]:::dto
        end
    end

    DataSource["CSV Files"]:::data

    %% Relationships
    Browser -->|HTTP GET HTML/CSS/JS| Handler
    Handler --> Index
    Handler --> AboutPage
    Handler --> GraphPage
    Handler --> WatchersPage
    Handler --> CSS
    Handler --> Scripts

    Browser -->|AJAX /api| AboutCtrl
    Browser -->|AJAX /api| DeptCtrl
    Browser -->|AJAX /api| OfferCtrl
    Browser -->|AJAX /api| WatcherCtrl
    Browser -->|AJAX /api| StatsCtrl
    Browser -->|AJAX /api| DumpCtrl

    AboutCtrl -->|invokes| ModelMgr
    DeptCtrl -->|invokes| ModelMgr
    OfferCtrl -->|invokes| ModelMgr
    WatcherCtrl -->|invokes| ModelMgr
    StatsCtrl -->|invokes| ModelMgr
    DumpCtrl -->|invokes| ModelMgr

    ModelMgr -->|uses| CSVProcessor
    CSVProcessor -->|reads| CSVReader
    CSVProcessor -->|converts| TermConv
    CSVReader -->|loads| DataSource

    AboutCtrl -->|maps to| AboutDTO
    DeptCtrl -->|maps to| DeptDTO
    OfferCtrl -->|maps to| CourseOffDTO
    WatcherCtrl -->|maps to| WatcherDTO
    StatsCtrl -->|maps to| GraphDTO
    DumpCtrl -->|maps to| OfferingDataDTO

    AboutDTO -->|JSON response| Browser
    DeptDTO -->|JSON response| Browser
    CourseOffDTO -->|JSON response| Browser
    WatcherDTO -->|JSON response| Browser
    GraphDTO -->|JSON response| Browser
    OfferingDataDTO -->|JSON response| Browser

    %% Click Events
    click Index "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/public/index.html"
    click AboutPage "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/public/about.html"
    click GraphPage "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/public/graph.html"
    click WatchersPage "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/public/watchers.html"
    click CSS "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/tree/main/public/css/"
    click Scripts "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/tree/main/public/scripts/"
    click App "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/CoursePlannerApplication.java"
    click AboutCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/AboutController.java"
    click DeptCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/DepartmentController.java"
    click OfferCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/OfferingController.java"
    click WatcherCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/WatcherController.java"
    click StatsCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/StatsController.java"
    click DumpCtrl "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/controllers/DumpModelController.java"
    click ModelMgr "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/ModelManager.java"
    click CSVReader "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/utils/CSVReader.java"
    click CSVProcessor "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/utils/CSVDataProcessor.java"
    click TermConv "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/utils/TermCodeConverter.java"
    click Dept "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/Department.java"
    click Course "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/Course.java"
    click CourseOff "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/CourseOffering.java"
    click Section "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/Section.java"
    click WatcherModel "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/models/Watcher.java"
    click AboutDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiAboutDTO.java"
    click DeptDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiDepartmentDTO.java"
    click CourseDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiCourseDTO.java"
    click CourseOffDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiCourseOfferingDTO.java"
    click OfferingSecDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiOfferingSectionDTO.java"
    click OfferingDataDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiOfferingDataDTO.java"
    click WatcherDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiWatcherDTO.java"
    click WatcherCreateDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiWatcherCreateDTO.java"
    click GraphDTO "https://github.com/normancao2702/cmpt213-asgn5-courseplanner/blob/main/src/main/java/ca/cmpt213/courseplanner/dto/ApiGraphDataPointDTO.java"

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#000
    classDef backend fill:#D3FFD3,stroke:#000
    classDef controller fill:#A7F3D0,stroke:#000
    classDef service fill:#6EE7B7,stroke:#000
    classDef util fill:#FDE68A,stroke:#000
    classDef model fill:#FBBF24,stroke:#000
    classDef dto fill:#BFDBFE,stroke:#000
    classDef data fill:#FEE2E2,stroke:#000
```
