How erik-cupsa/mcgill-scheduler works
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)