# erik-cupsa/mcgill-scheduler architecture

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

- Interactive diagram: https://gitdiagram.com/erik-cupsa/mcgill-scheduler
- Repository: https://github.com/erik-cupsa/mcgill-scheduler

## Overview

##### Project type and purpose
- This is a full-stack web application (“McGill Exam Scheduler”) that serves over 30,000 students.
- Frontend: ReactJS application hosted on Vercel.
- Backend: Spring Boot REST API packaged via Docker and hosted on Heroku.
- Persistence: PostgreSQL database holds exam data.

##### File structure
- Top-level directories:
- Backend (SpringBoot)/exam-scheduler – Spring Boot project with standard Maven layout (src/main/java, src/main/resources, src/test).
- Frontend (ReactJS) – React application with public/ and src/ subfolders, UI components, assets, and configuration.
- CSV files (Historic_Schedule.csv, Schedule_W2024.csv) likely used for seeding or data import.
- Notice separation between layers: controllers, services, repositories in backend; composable components in frontend.
- Config files: application.properties (DB credentials, server port), pom.xml, package.json, Dockerfile (implied), vercel.json (if any), mvnw scripts.

##### README for additional insights
- Backend exposes endpoints under /api/exams for CRUD operations.
- Frontend consumes these endpoints via fetch/axios configured in src/config.js.
- Deployment targets: Heroku (backend), Vercel (frontend), PostgreSQL (hosted externally or via Heroku add-on).

##### Elements
- Labels for each component and sub-layer (e.g., “ExamController”, “ExamService”).
- UI → API → Service → Repository → Database → UI
- Rectangles for application servers (React, Spring)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend Layer"
        direction TB
        B1("User Browser"):::client
        B2("Vercel Hosting"):::cloud
        B3("ReactJS App"):::frontend
        B4("App.js"):::frontend
        B5("Components"):::frontend
        B6("Public Assets"):::frontend
        B7("src/config.js"):::frontend
        B8("package.json"):::file
    end

    subgraph "Backend Layer"
        direction TB
        C1("Heroku Hosting"):::cloud
        C2("Spring Boot App"):::backend
        C3("McGillExamSchedulerApplication"):::backend
        C4("ExamController"):::backend
        C5("HistoricExamController"):::backend
        C6("ExamService"):::backend
        C7("HistoricExamService"):::backend
        C8("ExamRepository"):::backend
        C9("HistoricExamRepository"):::backend
        C10("Exam Model"):::backend
        C11("HistoricExam Model"):::backend
        C12("application.properties"):::file
        C13("pom.xml"):::file
    end

    subgraph "Database"
        direction TB
        D1["PostgreSQL Database"]:::db
    end

    subgraph "Data Sources"
        direction TB
        D2("Historic_Schedule.csv"):::file
        D3("Schedule_W2024.csv"):::file
    end

    B1 -->|"HTTP"| B2
    B2 --> B3
    B3 --> B4
    B4 --> B5
    B3 --> B7
    B3 --> B6
    B3 --> B8

    B3 -->|"REST calls /api/exams"| C1
    C1 --> C2
    C2 --> C3
    C3 --> C4
    C3 --> C5
    C4 --> C6
    C5 --> C7
    C6 --> C8
    C7 --> C9
    C8 --> C10
    C9 --> C11
    C3 --> C12
    C2 --> C13
    C8 --> D1
    C9 --> D1

    D2 -->|"Seeding"| D1
    D3 -->|"Seeding"| D1

    click B3 "https://github.com/erik-cupsa/mcgill-scheduler/tree/main/Frontend (ReactJS)/"
    click B4 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Frontend (ReactJS)/src/App.js"
    click B5 "https://github.com/erik-cupsa/mcgill-scheduler/tree/main/Frontend (ReactJS)/src/components/"
    click B6 "https://github.com/erik-cupsa/mcgill-scheduler/tree/main/Frontend (ReactJS)/public/"
    click B7 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Frontend (ReactJS)/src/config.js"
    click B8 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Frontend (ReactJS)/package.json"
    click C3 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/McGillExamSchedulerApplication.java"
    click C4 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/controller/ExamController.java"
    click C5 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/controller/HistoricExamController.java"
    click C6 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/service/ExamService.java"
    click C7 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/service/HistoricExamService.java"
    click C8 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/repo/ExamRepository.java"
    click C9 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/repo/HistoricExamRepository.java"
    click C10 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/model/Exam.java"
    click C11 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/java/com/mcgill/examscheduler/exam/model/HistoricExam.java"
    click C12 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/src/main/resources/application.properties"
    click C13 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Backend (SpringBoot)/exam-scheduler/pom.xml"
    click D2 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Historic_Schedule.csv"
    click D3 "https://github.com/erik-cupsa/mcgill-scheduler/blob/main/Schedule_W2024.csv"

    classDef frontend fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef backend fill:#90EE90,stroke:#333,stroke-width:1px
    classDef db fill:#32CD32,stroke:#333,stroke-width:1px
    classDef cloud fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef client fill:#FFD700,stroke:#333,stroke-width:1px
    classDef file fill:#FFEFD5,stroke:#333,stroke-width:1px
```
