# singhadi0/phd architecture

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

- Interactive diagram: https://gitdiagram.com/singhadi0/phd
- Repository: https://github.com/singhadi0/phd

## Overview

Research X is a multi-tenant PhD lifecycle platform for administrators, scholars, supervisors, and developers. Users authenticate, select or resolve a tenant membership, then enter a role-specific workspace. Admin workflows cover admissions, programs, scholar enrollment, communications, documents, and fees; scholars track onboarding, coursework, finances, and meetings, while supervisors and developers have dedicated workspaces. The README documents these capabilities; several routes and modules were not sampled, so their internal connections are shown only where documented or indexed.

Main entry points: [`app/(tenant)/[tenantSlug]`](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D) (Tenant workspace entry), [`app/(tenant)/[tenantSlug]/(dashboard)/admin`](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/admin) (Admin console), [`lib/db.ts`](https://github.com/singhadi0/phd/blob/master/lib/db.ts) (PostgreSQL database), [`lib/auth/session.ts`](https://github.com/singhadi0/phd/blob/master/lib/auth/session.ts) (Session and membership)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity and tenancy"]
  node_auth_ui["Login and registration"]
  node_auth_api["Auth endpoints"]
  node_session["Session and membership<br/>[session.ts]"]
  node_role_access["Role access checks<br/>[rbac.ts]"]
  node_tenant_entry["Tenant workspace entry"]
  node_navigation["Role dashboard routing<br/>[navigation.ts]"]
end

subgraph group_operations["Academic operations"]
  node_admin_ui["Admin console"]
  node_admissions["Admissions management<br/>[admissions.ts]"]
  node_programs["Programs and courses<br/>[programs.ts]"]
  node_scholar_admin["Scholar administration<br/>[scholars.ts]"]
  node_finance["Fee ledger<br/>[finance.ts]"]
  node_communications["Admin communications<br/>[communications.ts]"]
end

subgraph group_workspaces["Role workspaces"]
  node_scholar_ui["Scholar workspace"]
  node_scholar_summary["Scholar dashboard summary<br/>[scholar.ts]"]
  node_supervisor_ui["Supervisor workspace"]
  node_developer_ui["Developer console"]
end

subgraph group_platform["Data and messaging"]
  node_database[("PostgreSQL database<br/>[db.ts]")]
  node_invitation_email["Scholar invitation email<br/>[scholar-invite.ts]"]
  node_mailer["Email delivery<br/>[mailer.ts]"]
end

node_user(("Platform user"))

node_user -->|"signs in"| node_auth_ui
node_auth_ui -.->|"submits credentials"| node_auth_api
node_auth_api -->|"resolves session"| node_session
node_auth_api -->|"updates tenant"| node_database
node_auth_api -->|"resolves redirect"| node_navigation
node_user -->|"opens tenant"| node_tenant_entry
node_tenant_entry -->|"requires session"| node_session
node_tenant_entry -->|"checks roles"| node_role_access
node_tenant_entry -->|"checks membership"| node_navigation
node_navigation -->|"requires membership"| node_session
node_tenant_entry -->|"routes managers"| node_admin_ui
node_tenant_entry -->|"routes scholars"| node_scholar_ui
node_tenant_entry -->|"routes supervisors"| node_supervisor_ui
node_tenant_entry -->|"routes developers"| node_developer_ui
node_admin_ui -->|"requires membership"| node_session
node_admin_ui -->|"checks roles"| node_role_access
node_admin_ui -.->|"manages admissions"| node_admissions
node_admin_ui -.->|"manages catalogs"| node_programs
node_admin_ui -->|"enrolls scholars"| node_scholar_admin
node_admin_ui -.->|"manages fees"| node_finance
node_admin_ui -.->|"sends broadcasts"| node_communications
node_scholar_ui -->|"requires membership"| node_session
node_scholar_ui -->|"loads summary"| node_scholar_summary
node_scholar_summary -->|"reads records"| node_database
node_scholar_ui -.->|"loads tenant data"| node_database
node_scholar_admin -->|"reads and writes"| node_database
node_scholar_admin -->|"sends invitations"| node_invitation_email
node_invitation_email -->|"delegates delivery"| node_mailer
node_database -->|"stores platform data"| node_user

click node_auth_ui "https://github.com/singhadi0/phd/tree/master/app/(public)"
click node_auth_api "https://github.com/singhadi0/phd/tree/master/app/api/auth"
click node_session "https://github.com/singhadi0/phd/blob/master/lib/auth/session.ts"
click node_role_access "https://github.com/singhadi0/phd/blob/master/lib/auth/rbac.ts"
click node_tenant_entry "https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D"
click node_navigation "https://github.com/singhadi0/phd/blob/master/lib/auth/navigation.ts"
click node_admin_ui "https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/admin"
click node_admissions "https://github.com/singhadi0/phd/blob/master/lib/admin/admissions.ts"
click node_programs "https://github.com/singhadi0/phd/blob/master/lib/admin/programs.ts"
click node_scholar_admin "https://github.com/singhadi0/phd/blob/master/lib/admin/scholars.ts"
click node_finance "https://github.com/singhadi0/phd/blob/master/lib/admin/finance.ts"
click node_communications "https://github.com/singhadi0/phd/blob/master/lib/admin/communications.ts"
click node_scholar_ui "https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/scholar"
click node_scholar_summary "https://github.com/singhadi0/phd/blob/master/lib/dashboard/scholar.ts"
click node_supervisor_ui "https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/supervisor"
click node_developer_ui "https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/developer"
click node_database "https://github.com/singhadi0/phd/blob/master/lib/db.ts"
click node_invitation_email "https://github.com/singhadi0/phd/blob/master/lib/email/scholar-invite.ts"
click node_mailer "https://github.com/singhadi0/phd/blob/master/lib/email/mailer.ts"

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_auth_ui,node_auth_api,node_session,node_role_access,node_tenant_entry,node_navigation,node_user toneBlue
class node_admin_ui,node_admissions,node_programs,node_scholar_admin,node_finance,node_communications toneAmber
class node_scholar_ui,node_scholar_summary,node_supervisor_ui,node_developer_ui toneMint
class node_database,node_invitation_email,node_mailer toneRose
```

## Components

### Identity and tenancy

- [Login and registration](https://github.com/singhadi0/phd/tree/master/app/(public)): `app/(public)`
- [Auth endpoints](https://github.com/singhadi0/phd/tree/master/app/api/auth): `app/api/auth`
- [Session and membership](https://github.com/singhadi0/phd/blob/master/lib/auth/session.ts): `lib/auth/session.ts`
- [Role access checks](https://github.com/singhadi0/phd/blob/master/lib/auth/rbac.ts): `lib/auth/rbac.ts`
- [Tenant workspace entry](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D): `app/(tenant)/[tenantSlug]`
- [Role dashboard routing](https://github.com/singhadi0/phd/blob/master/lib/auth/navigation.ts): `lib/auth/navigation.ts`

### Academic operations

- [Admin console](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/admin): `app/(tenant)/[tenantSlug]/(dashboard)/admin`
- [Admissions management](https://github.com/singhadi0/phd/blob/master/lib/admin/admissions.ts): `lib/admin/admissions.ts`
- [Programs and courses](https://github.com/singhadi0/phd/blob/master/lib/admin/programs.ts): `lib/admin/programs.ts`
- [Scholar administration](https://github.com/singhadi0/phd/blob/master/lib/admin/scholars.ts): `lib/admin/scholars.ts`
- [Fee ledger](https://github.com/singhadi0/phd/blob/master/lib/admin/finance.ts): `lib/admin/finance.ts`
- [Admin communications](https://github.com/singhadi0/phd/blob/master/lib/admin/communications.ts): `lib/admin/communications.ts`

### Role workspaces

- [Scholar workspace](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/scholar): `app/(tenant)/[tenantSlug]/(dashboard)/scholar`
- [Scholar dashboard summary](https://github.com/singhadi0/phd/blob/master/lib/dashboard/scholar.ts): `lib/dashboard/scholar.ts`
- [Supervisor workspace](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/supervisor): `app/(tenant)/[tenantSlug]/(dashboard)/supervisor`
- [Developer console](https://github.com/singhadi0/phd/tree/master/app/(tenant)/%5BtenantSlug%5D/(dashboard)/developer): `app/(tenant)/[tenantSlug]/(dashboard)/developer`

### Data and messaging

- [PostgreSQL database](https://github.com/singhadi0/phd/blob/master/lib/db.ts): `lib/db.ts`
- [Scholar invitation email](https://github.com/singhadi0/phd/blob/master/lib/email/scholar-invite.ts): `lib/email/scholar-invite.ts`
- [Email delivery](https://github.com/singhadi0/phd/blob/master/lib/email/mailer.ts): `lib/email/mailer.ts`

### Other components

- **Platform user**

## Connections

- Platform user → Login and registration: signs in
- Login and registration → Auth endpoints: submits credentials
- Auth endpoints → Session and membership: resolves session (evidence: `app/api/auth/post-login/route.ts`)
- Auth endpoints → PostgreSQL database: updates tenant (evidence: `app/api/auth/tenant/route.ts`)
- Auth endpoints → Role dashboard routing: resolves redirect (evidence: `app/api/auth/post-login/route.ts`)
- Platform user → Tenant workspace entry: opens tenant
- Tenant workspace entry → Session and membership: requires session (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Tenant workspace entry → Role access checks: checks roles (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Tenant workspace entry → Role dashboard routing: checks membership (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Role dashboard routing → Session and membership: requires membership (evidence: `lib/auth/navigation.ts`)
- Tenant workspace entry → Admin console: routes managers (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Tenant workspace entry → Scholar workspace: routes scholars (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Tenant workspace entry → Supervisor workspace: routes supervisors (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Tenant workspace entry → Developer console: routes developers (evidence: `app/(tenant)/[tenantSlug]/page.tsx`)
- Admin console → Session and membership: requires membership (evidence: `app/(tenant)/[tenantSlug]/(dashboard)/admin/page.tsx`)
- Admin console → Role access checks: checks roles (evidence: `app/(tenant)/[tenantSlug]/(dashboard)/admin/page.tsx`)
- Admin console → Admissions management: manages admissions
- Admin console → Programs and courses: manages catalogs
- Admin console → Scholar administration: enrolls scholars
- Admin console → Fee ledger: manages fees
- Admin console → Admin communications: sends broadcasts
- Scholar workspace → Session and membership: requires membership (evidence: `app/(tenant)/[tenantSlug]/(dashboard)/scholar/page.tsx`)
- Scholar workspace → Scholar dashboard summary: loads summary (evidence: `app/(tenant)/[tenantSlug]/(dashboard)/scholar/page.tsx`)
- Scholar dashboard summary → PostgreSQL database: reads records (evidence: `lib/dashboard/scholar.ts`)
- Scholar workspace → PostgreSQL database: loads tenant data
- Scholar administration → PostgreSQL database: reads and writes (evidence: `lib/admin/scholars.ts`)
- Scholar administration → Scholar invitation email: sends invitations (evidence: `lib/admin/scholars.ts`)
- Scholar invitation email → Email delivery: delegates delivery (evidence: `lib/email/scholar-invite.ts`)
- PostgreSQL database → Platform user: stores platform data
