# yusufkula/uniod architecture

> Architecture diagram of the GitHub repository yusufkula/uniod, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yusufkula/uniod
- Repository: https://github.com/yusufkula/uniod

## Overview

UniOD is a university comparison and open-day reminder application: users browse aggregated university rankings and open-day details, manage favorites and accounts, and schedule reminders. The main data path combines four scraped datasets into a shared university record; authenticated API routes use that data and MongoDB for favorites, account operations, and reminders. The graph preserves the listed UI and data-collection capabilities, but scraper internals and several page/API interactions were not excerpted, so uncertain links are omitted.

Main entry points: [`lib/mongodb.ts`](https://github.com/yusufkula/uniod/blob/main/lib/mongodb.ts) (MongoDB), [`models/user.ts`](https://github.com/yusufkula/uniod/blob/main/models/user.ts) (User model), [`util/combineUniData.tsx`](https://github.com/yusufkula/uniod/blob/main/util/combineUniData.tsx) (University data merger), [`app/api/setReminder/route.js`](https://github.com/yusufkula/uniod/blob/main/app/api/setReminder/route.js) (Set reminder endpoint)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["User experience"]
  node_home["University explorer<br/>[page.tsx]"]
  node_favorites["Favorites page<br/>[page.tsx]"]
  node_table["University table<br/>[UniTable.tsx]"]
  node_login["Login form<br/>[LoginForm.tsx]"]
  node_register["Registration form<br/>[RegisterForm.tsx]"]
  node_account["Account page<br/>[page.tsx]"]
  node_reminderform["Reminder form"]
end

subgraph group_api["Application API"]
  node_auth["Credentials authentication<br/>[route.ts]"]
  node_getdata["University data endpoint<br/>[route.ts]"]
  node_addfavorite["Add favorite endpoint<br/>[route.js]"]
  node_getfavorites["Get favorites endpoint<br/>[route.ts]"]
  node_removefavorite["Remove favorite endpoint<br/>[route.ts]"]
  node_registration["Registration endpoint<br/>[route.ts]"]
  node_accountupdate["Account update endpoint<br/>[route.ts]"]
  node_usercheck["User existence endpoint<br/>[route.ts]"]
end

subgraph group_data["University data"]
  node_combined["University data merger<br/>[combineUniData.tsx]"]
  node_guardian["Guardian rankings scraper<br/>[scrapeGuardian.tsx]"]
  node_cug["CUG rankings scraper<br/>[scrapeCUG.tsx]"]
  node_opendays["Open-day dates scraper"]
  node_ucas["UCAS codes scraper<br/>[scrapeUcasCode.tsx]"]
end

subgraph group_accounts["Accounts and persistence"]
  node_database[("MongoDB<br/>[mongodb.ts]")]
  node_users["User model<br/>[user.ts]"]
end

subgraph group_reminders["Open-day reminders"]
  node_setreminder["Set reminder endpoint<br/>[route.js]"]
  node_emailcontent["Reminder email builder<br/>[email.ts]"]
  node_scheduler["Email scheduler<br/>[scheduleEmail.js]"]
end

node_visitor(("Visitor"))
node_mailservice["Gmail delivery"]

node_visitor -->|"browses"| node_home
node_visitor -->|"views"| node_favorites
node_visitor -->|"signs in"| node_login
node_visitor -->|"registers"| node_register
node_visitor -->|"manages account"| node_account
node_visitor -->|"sets reminder"| node_reminderform
node_home -->|"renders"| node_table
node_favorites -->|"renders"| node_table
node_login -.->|"authenticates"| node_auth
node_register -.->|"submits registration"| node_registration
node_account -.->|"updates account"| node_accountupdate
node_reminderform -.->|"submits reminder"| node_setreminder
node_table -->|"adds favorite"| node_addfavorite
node_table -->|"removes favorite"| node_removefavorite
node_getdata -->|"gets data"| node_combined
node_addfavorite -->|"finds university"| node_combined
node_setreminder -->|"finds university"| node_combined
node_combined -->|"scrapes rankings"| node_guardian
node_combined -->|"scrapes rankings"| node_cug
node_combined -->|"scrapes dates"| node_opendays
node_combined -->|"scrapes codes"| node_ucas
node_auth -->|"connects"| node_database
node_auth -->|"looks up user"| node_users
node_registration -->|"connects"| node_database
node_registration -->|"creates user"| node_users
node_usercheck -->|"connects"| node_database
node_usercheck -->|"checks user"| node_users
node_getfavorites -->|"connects"| node_database
node_getfavorites -->|"reads favorites"| node_users
node_addfavorite -->|"connects"| node_database
node_addfavorite -->|"saves favorite"| node_users
node_removefavorite -->|"connects"| node_database
node_removefavorite -->|"removes favorite"| node_users
node_accountupdate -->|"connects"| node_database
node_accountupdate -->|"updates user"| node_users
node_setreminder -->|"connects"| node_database
node_setreminder -->|"looks up user"| node_users
node_setreminder -->|"builds email"| node_emailcontent
node_setreminder -->|"schedules email"| node_scheduler
node_emailcontent -->|"configures transport"| node_mailservice
node_scheduler -.->|"sends scheduled mail"| node_mailservice

click node_home "https://github.com/yusufkula/uniod/blob/main/app/home/page.tsx"
click node_favorites "https://github.com/yusufkula/uniod/blob/main/app/favorites/page.tsx"
click node_table "https://github.com/yusufkula/uniod/blob/main/components/UniTable.tsx"
click node_login "https://github.com/yusufkula/uniod/blob/main/components/LoginForm.tsx"
click node_register "https://github.com/yusufkula/uniod/blob/main/components/RegisterForm.tsx"
click node_account "https://github.com/yusufkula/uniod/blob/main/app/myAccount/page.tsx"
click node_reminderform "https://github.com/yusufkula/uniod/blob/main/components/OpenDayReminderForm.tsx"
click node_auth "https://github.com/yusufkula/uniod/blob/main/app/api/auth/%5B...nextauth%5D/route.ts"
click node_getdata "https://github.com/yusufkula/uniod/blob/main/app/api/getUniData/route.ts"
click node_addfavorite "https://github.com/yusufkula/uniod/blob/main/app/api/addFavoriteUni/route.js"
click node_getfavorites "https://github.com/yusufkula/uniod/blob/main/app/api/getFavoriteUnis/route.ts"
click node_removefavorite "https://github.com/yusufkula/uniod/blob/main/app/api/removeFavoriteUni/route.ts"
click node_registration "https://github.com/yusufkula/uniod/blob/main/app/api/register/route.ts"
click node_accountupdate "https://github.com/yusufkula/uniod/blob/main/app/api/updateAccount/route.ts"
click node_usercheck "https://github.com/yusufkula/uniod/blob/main/app/api/userExists/route.ts"
click node_combined "https://github.com/yusufkula/uniod/blob/main/util/combineUniData.tsx"
click node_guardian "https://github.com/yusufkula/uniod/blob/main/util/scrapeGuardian.tsx"
click node_cug "https://github.com/yusufkula/uniod/blob/main/util/scrapeCUG.tsx"
click node_opendays "https://github.com/yusufkula/uniod/blob/main/util/scrapeOpenDayDates.tsx"
click node_ucas "https://github.com/yusufkula/uniod/blob/main/util/scrapeUcasCode.tsx"
click node_database "https://github.com/yusufkula/uniod/blob/main/lib/mongodb.ts"
click node_users "https://github.com/yusufkula/uniod/blob/main/models/user.ts"
click node_setreminder "https://github.com/yusufkula/uniod/blob/main/app/api/setReminder/route.js"
click node_emailcontent "https://github.com/yusufkula/uniod/blob/main/Email/email.ts"
click node_scheduler "https://github.com/yusufkula/uniod/blob/main/Email/scheduleEmail.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_home,node_favorites,node_table,node_login,node_register,node_account,node_reminderform toneBlue
class node_auth,node_getdata,node_addfavorite,node_getfavorites,node_removefavorite,node_registration,node_accountupdate,node_usercheck toneAmber
class node_combined,node_guardian,node_cug,node_opendays,node_ucas toneMint
class node_database,node_users toneRose
class node_setreminder,node_emailcontent,node_scheduler,node_visitor,node_mailservice toneIndigo
```

## Components

### User experience

- [University explorer](https://github.com/yusufkula/uniod/blob/main/app/home/page.tsx): `app/home/page.tsx`
- [Favorites page](https://github.com/yusufkula/uniod/blob/main/app/favorites/page.tsx): `app/favorites/page.tsx`
- [University table](https://github.com/yusufkula/uniod/blob/main/components/UniTable.tsx): `components/UniTable.tsx`
- [Login form](https://github.com/yusufkula/uniod/blob/main/components/LoginForm.tsx): `components/LoginForm.tsx`
- [Registration form](https://github.com/yusufkula/uniod/blob/main/components/RegisterForm.tsx): `components/RegisterForm.tsx`
- [Account page](https://github.com/yusufkula/uniod/blob/main/app/myAccount/page.tsx): `app/myAccount/page.tsx`
- [Reminder form](https://github.com/yusufkula/uniod/blob/main/components/OpenDayReminderForm.tsx): `components/OpenDayReminderForm.tsx`

### Application API

- [Credentials authentication](https://github.com/yusufkula/uniod/blob/main/app/api/auth/%5B...nextauth%5D/route.ts): `app/api/auth/[...nextauth]/route.ts`
- [University data endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/getUniData/route.ts): `app/api/getUniData/route.ts`
- [Add favorite endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/addFavoriteUni/route.js): `app/api/addFavoriteUni/route.js`
- [Get favorites endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/getFavoriteUnis/route.ts): `app/api/getFavoriteUnis/route.ts`
- [Remove favorite endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/removeFavoriteUni/route.ts): `app/api/removeFavoriteUni/route.ts`
- [Registration endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/register/route.ts): `app/api/register/route.ts`
- [Account update endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/updateAccount/route.ts): `app/api/updateAccount/route.ts`
- [User existence endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/userExists/route.ts): `app/api/userExists/route.ts`

### University data

- [University data merger](https://github.com/yusufkula/uniod/blob/main/util/combineUniData.tsx): `util/combineUniData.tsx`
- [Guardian rankings scraper](https://github.com/yusufkula/uniod/blob/main/util/scrapeGuardian.tsx): `util/scrapeGuardian.tsx`
- [CUG rankings scraper](https://github.com/yusufkula/uniod/blob/main/util/scrapeCUG.tsx): `util/scrapeCUG.tsx`
- [Open-day dates scraper](https://github.com/yusufkula/uniod/blob/main/util/scrapeOpenDayDates.tsx): `util/scrapeOpenDayDates.tsx`
- [UCAS codes scraper](https://github.com/yusufkula/uniod/blob/main/util/scrapeUcasCode.tsx): `util/scrapeUcasCode.tsx`

### Accounts and persistence

- [MongoDB](https://github.com/yusufkula/uniod/blob/main/lib/mongodb.ts): `lib/mongodb.ts`
- [User model](https://github.com/yusufkula/uniod/blob/main/models/user.ts): `models/user.ts`

### Open-day reminders

- [Set reminder endpoint](https://github.com/yusufkula/uniod/blob/main/app/api/setReminder/route.js): `app/api/setReminder/route.js`
- [Reminder email builder](https://github.com/yusufkula/uniod/blob/main/Email/email.ts): `Email/email.ts`
- [Email scheduler](https://github.com/yusufkula/uniod/blob/main/Email/scheduleEmail.js): `Email/scheduleEmail.js`

### Other components

- **Visitor**
- **Gmail delivery**

## Connections

- Visitor → University explorer: browses
- Visitor → Favorites page: views
- Visitor → Login form: signs in
- Visitor → Registration form: registers
- Visitor → Account page: manages account
- Visitor → Reminder form: sets reminder
- University explorer → University table: renders (evidence: `app/home/page.tsx`)
- Favorites page → University table: renders (evidence: `app/favorites/page.tsx`)
- Login form → Credentials authentication: authenticates
- Registration form → Registration endpoint: submits registration
- Account page → Account update endpoint: updates account
- Reminder form → Set reminder endpoint: submits reminder
- University table → Add favorite endpoint: adds favorite (evidence: `components/UniTable.tsx`)
- University table → Remove favorite endpoint: removes favorite (evidence: `components/UniTable.tsx`)
- University data endpoint → University data merger: gets data (evidence: `util/combineUniData.tsx`)
- Add favorite endpoint → University data merger: finds university (evidence: `app/api/addFavoriteUni/route.js`)
- Set reminder endpoint → University data merger: finds university (evidence: `app/api/setReminder/route.js`)
- University data merger → Guardian rankings scraper: scrapes rankings (evidence: `util/combineUniData.tsx`)
- University data merger → CUG rankings scraper: scrapes rankings (evidence: `util/combineUniData.tsx`)
- University data merger → Open-day dates scraper: scrapes dates (evidence: `util/combineUniData.tsx`)
- University data merger → UCAS codes scraper: scrapes codes (evidence: `util/combineUniData.tsx`)
- Credentials authentication → MongoDB: connects (evidence: `app/api/auth/[...nextauth]/route.ts`)
- Credentials authentication → User model: looks up user (evidence: `app/api/auth/[...nextauth]/route.ts`)
- Registration endpoint → MongoDB: connects (evidence: `app/api/register/route.ts`)
- Registration endpoint → User model: creates user (evidence: `app/api/register/route.ts`)
- User existence endpoint → MongoDB: connects (evidence: `app/api/userExists/route.ts`)
- User existence endpoint → User model: checks user (evidence: `app/api/userExists/route.ts`)
- Get favorites endpoint → MongoDB: connects (evidence: `app/api/getFavoriteUnis/route.ts`)
- Get favorites endpoint → User model: reads favorites (evidence: `app/api/getFavoriteUnis/route.ts`)
- Add favorite endpoint → MongoDB: connects (evidence: `app/api/addFavoriteUni/route.js`)
- Add favorite endpoint → User model: saves favorite (evidence: `app/api/addFavoriteUni/route.js`)
- Remove favorite endpoint → MongoDB: connects (evidence: `app/api/removeFavoriteUni/route.ts`)
- Remove favorite endpoint → User model: removes favorite (evidence: `app/api/removeFavoriteUni/route.ts`)
- Account update endpoint → MongoDB: connects (evidence: `app/api/updateAccount/route.ts`)
- Account update endpoint → User model: updates user (evidence: `app/api/updateAccount/route.ts`)
- Set reminder endpoint → MongoDB: connects (evidence: `app/api/setReminder/route.js`)
- Set reminder endpoint → User model: looks up user (evidence: `app/api/setReminder/route.js`)
- Set reminder endpoint → Reminder email builder: builds email (evidence: `app/api/setReminder/route.js`)
- Set reminder endpoint → Email scheduler: schedules email (evidence: `app/api/setReminder/route.js`)
- Reminder email builder → Gmail delivery: configures transport (evidence: `Email/email.ts`)
- Email scheduler → Gmail delivery: sends scheduled mail
