# arafaykhalid/eutcm-api architecture

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

- Interactive diagram: https://gitdiagram.com/arafaykhalid/eutcm-api
- Repository: https://github.com/arafaykhalid/eutcm-api

## Overview

HITMS is a full-stack admissions and campus-information portal: candidates use the web app to manage application materials and entry-test steps, while administrators manage candidates, reviews, and public content. The API provides authentication, candidate and admin operations, and public content endpoints over a Mongo-backed Express service. The tree establishes the broader feature areas, but most route wiring and frontend-to-API calls were not sampled; those connections are therefore omitted rather than inferred.

Main entry points: [`apps/api/src/server.ts`](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/server.ts) (Express server), [`apps/api/src/models/user.model.ts`](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/models/user.model.ts) (User records), [`apps/api/src/controllers/auth`](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/auth) (Authentication API), [`apps/web/src/app`](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app) (Web application)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web experience"]
  node_webapp["Web application"]
  node_authstate["Auth state<br/>[useAuth.ts]"]
  node_candidateportal["Candidate portal"]
  node_adminportal["Admin portal"]
end

subgraph group_identity["Identity and sessions"]
  node_authapi["Authentication API"]
  node_sessions["Session management"]
  node_sessionutil["Session limits"]
  node_usermodel[("User records<br/>[user.model.ts]")]
end

subgraph group_admissions["Admissions workflow"]
  node_candidatework["Candidate application"]
  node_education["Education details"]
  node_personalinfo["Personal details"]
  node_challan["Entry-test challan"]
  node_adminreview["Admin reviews"]
  node_entrytest["Entry-test access"]
end

subgraph group_campus["Campus content"]
  node_publiccontent["Public content"]
  node_contentmodels[("Content records")]
  node_admincontent["Content administration"]
end

subgraph group_runtime["API runtime"]
  node_server["Express server<br/>[server.ts]"]
  node_router["API routes<br/>[index.ts]"]
  node_config["Runtime config<br/>[index.ts]"]
  node_rate["Request limiting"]
  node_cors["CORS policy<br/>[corsOptions.ts]"]
  node_mongo["Database connection<br/>[mongoose.ts]"]
  node_logger["Logging<br/>[winston.ts]"]
end

node_visitor(("Candidate or admin"))

node_visitor -.->|"uses"| node_webapp
node_webapp -.->|"offers"| node_candidateportal
node_webapp -.->|"offers"| node_adminportal
node_authapi -->|"looks up"| node_usermodel
node_authapi -->|"prunes sessions"| node_sessionutil
node_authapi -->|"saves session"| node_usermodel
node_sessions -->|"reads sessions"| node_usermodel
node_adminreview -->|"reviews application"| node_usermodel
node_publiccontent -->|"reads published items"| node_contentmodels
node_server -->|"mounts routes"| node_router
node_server -->|"reads config"| node_config
node_server -->|"applies limiter"| node_rate
node_server -->|"applies policy"| node_cors
node_server -->|"connects database"| node_mongo
node_server -->|"logs events"| node_logger

click node_webapp "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app"
click node_authstate "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/web/src/stores/useAuth.ts"
click node_candidateportal "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app/dashboard"
click node_adminportal "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app/admin"
click node_authapi "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/auth"
click node_sessions "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/user"
click node_sessionutil "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/utils/sessionManager.util.ts"
click node_usermodel "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/models/user.model.ts"
click node_candidatework "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/application"
click node_education "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/education"
click node_personalinfo "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/personalInfo"
click node_challan "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/challan"
click node_adminreview "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/managementByAdmins"
click node_entrytest "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/managementByAdmins/entryTest"
click node_publiccontent "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/controllers/content/public.controller.ts"
click node_contentmodels "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/models"
click node_admincontent "https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/admin/content"
click node_server "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/server.ts"
click node_router "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/routes/index.ts"
click node_config "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/config/index.ts"
click node_rate "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/expressRateLimiter.ts"
click node_cors "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/corsOptions.ts"
click node_mongo "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/mongoose.ts"
click node_logger "https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/winston.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_webapp,node_authstate,node_candidateportal,node_adminportal toneBlue
class node_authapi,node_sessions,node_sessionutil,node_usermodel toneAmber
class node_candidatework,node_education,node_personalinfo,node_challan,node_adminreview,node_entrytest toneMint
class node_publiccontent,node_contentmodels,node_admincontent toneRose
class node_server,node_router,node_config,node_rate,node_cors,node_mongo,node_logger,node_visitor toneIndigo
```

## Components

### Web experience

- [Web application](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app): `apps/web/src/app`
- [Auth state](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/web/src/stores/useAuth.ts): `apps/web/src/stores/useAuth.ts`
- [Candidate portal](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app/dashboard): `apps/web/src/app/dashboard`
- [Admin portal](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/web/src/app/admin): `apps/web/src/app/admin`

### Identity and sessions

- [Authentication API](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/auth): `apps/api/src/controllers/auth`
- [Session management](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/user): `apps/api/src/controllers/user`
- [Session limits](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/utils/sessionManager.util.ts): `apps/api/src/utils/sessionManager.util.ts`
- [User records](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/models/user.model.ts): `apps/api/src/models/user.model.ts`

### Admissions workflow

- [Candidate application](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/application): `apps/api/src/controllers/candidates/application`
- [Education details](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/education): `apps/api/src/controllers/candidates/education`
- [Personal details](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/personalInfo): `apps/api/src/controllers/candidates/personalInfo`
- [Entry-test challan](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/challan): `apps/api/src/controllers/candidates/challan`
- [Admin reviews](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/managementByAdmins): `apps/api/src/controllers/candidates/managementByAdmins`
- [Entry-test access](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/candidates/managementByAdmins/entryTest): `apps/api/src/controllers/candidates/managementByAdmins/entryTest`

### Campus content

- [Public content](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/controllers/content/public.controller.ts): `apps/api/src/controllers/content/public.controller.ts`
- [Content records](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/models): `apps/api/src/models`
- [Content administration](https://github.com/arafaykhalid/eutcm-api/tree/main/apps/api/src/controllers/admin/content): `apps/api/src/controllers/admin/content`

### API runtime

- [Express server](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/server.ts): `apps/api/src/server.ts`
- [API routes](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/routes/index.ts): `apps/api/src/routes/index.ts`
- [Runtime config](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/config/index.ts): `apps/api/src/config/index.ts`
- [Request limiting](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/expressRateLimiter.ts): `apps/api/src/lib/expressRateLimiter.ts`
- [CORS policy](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/corsOptions.ts): `apps/api/src/lib/corsOptions.ts`
- [Database connection](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/mongoose.ts): `apps/api/src/lib/mongoose.ts`
- [Logging](https://github.com/arafaykhalid/eutcm-api/blob/main/apps/api/src/lib/winston.ts): `apps/api/src/lib/winston.ts`

### Other components

- **Candidate or admin**

## Connections

- Candidate or admin → Web application: uses
- Web application → Candidate portal: offers
- Web application → Admin portal: offers
- Authentication API → User records: looks up (evidence: `apps/api/src/controllers/auth/login.controller.ts`)
- Authentication API → Session limits: prunes sessions (evidence: `apps/api/src/controllers/auth/login.controller.ts`)
- Authentication API → User records: saves session (evidence: `apps/api/src/controllers/auth/login.controller.ts`)
- Session management → User records: reads sessions (evidence: `apps/api/src/controllers/user/getSessions.controller.ts`)
- Admin reviews → User records: reviews application (evidence: `apps/api/src/controllers/candidates/managementByAdmins/application/reviewApplication.controller.ts`)
- Public content → Content records: reads published items (evidence: `apps/api/src/controllers/content/public.controller.ts`)
- Express server → API routes: mounts routes (evidence: `apps/api/src/server.ts`)
- Express server → Runtime config: reads config (evidence: `apps/api/src/server.ts`)
- Express server → Request limiting: applies limiter (evidence: `apps/api/src/server.ts`)
- Express server → CORS policy: applies policy (evidence: `apps/api/src/server.ts`)
- Express server → Database connection: connects database (evidence: `apps/api/src/server.ts`)
- Express server → Logging: logs events (evidence: `apps/api/src/server.ts`)
