# animation-tech-253/fyp architecture

> Architecture diagram of the GitHub repository animation-tech-253/fyp, 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/animation-tech-253/fyp
- Repository: https://github.com/animation-tech-253/fyp

## Overview

SUATS is a role-based university application submission and review system. Students submit applications and supporting files; examiners and department leadership review, request documents, forward or decide them, while administrators manage users, departments and settings. The frontend routes role-specific workspaces through Redux and HTTP APIs, with sockets for live updates. The backend mounts domain APIs and uses controllers, Mongo models, and notification/email/PDF integrations. Analytics, chatbot and VC capabilities are present in the tree but their detailed flows are not shown; edges for them are therefore omitted.

Main entry points: [`backend/src/controllers/application.controller.js`](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/application.controller.js) (Application workflow), [`frontend/src/App.jsx`](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/App.jsx) (Role-based app), [`backend/src/app.js`](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/app.js) (Express API), [`frontend/src/store/slices/applicationsSlice.js`](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/store/slices/applicationsSlice.js) (Client state)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Role Workspaces"]
  node_web["Role-based app<br/>[App.jsx]"]
  node_submit["Student submission"]
  node_review["Review workspaces<br/>[HODReviewPage.jsx]"]
  node_adminui["Admin workspace"]
  node_clientstate["Client state"]
  node_api_client["HTTP client<br/>[api.js]"]
  node_live_client["Socket client<br/>[useSocket.js]"]
end

subgraph group_api["Backend API"]
  node_server["Express API<br/>[app.js]"]
  node_application_routes["Application routes"]
  node_user_routes["User routes<br/>[user.routes.js]"]
end

subgraph group_domain["Application Domain"]
  node_application_logic["Application workflow"]
  node_user_logic["User administration<br/>[user.controller.js]"]
  node_admin_logic["Admin operations"]
  node_other_domains["Other domain APIs"]
  node_models[("Mongo models<br/>[index.js]")]
end

subgraph group_infra["Live and Integrations"]
  node_notifications["Live notifications<br/>[index.js]"]
  node_email["Application email"]
  node_pdf["PDF export<br/>[pdfGenerator.js]"]
  node_cloud["Profile image storage<br/>[cloudinary.js]"]
end

node_people(("University users"))
node_mail_provider["Email service"]
node_cloudinary_service["Cloudinary"]

node_people -->|"use"| node_web
node_web -->|"routes to"| node_submit
node_web -->|"routes to"| node_review
node_web -->|"routes to"| node_adminui
node_submit -->|"dispatches"| node_clientstate
node_review -->|"dispatches"| node_clientstate
node_clientstate -->|"requests"| node_api_client
node_api_client -.->|"HTTP calls"| node_server
node_server -->|"mounts"| node_application_routes
node_server -->|"mounts"| node_user_routes
node_application_routes -->|"routes requests"| node_application_logic
node_user_routes -->|"routes requests"| node_user_logic
node_application_logic -->|"reads and writes"| node_models
node_user_logic -->|"reads and writes"| node_models
node_application_logic -->|"emits events"| node_notifications
node_application_logic -->|"sends mail"| node_email
node_application_logic -->|"generates export"| node_pdf
node_user_logic -->|"uploads images"| node_cloud
node_cloud -.->|"stores files"| node_cloudinary_service
node_email -.->|"delivers mail"| node_mail_provider
node_live_client -->|"updates state"| node_clientstate
node_notifications -.->|"pushes events"| node_live_client
node_admin_logic -->|"uses models"| node_models
node_server -->|"mounts domain APIs"| node_other_domains

click node_web "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/App.jsx"
click node_submit "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/student/SubmitApplicationPage.jsx"
click node_review "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/hod/HODReviewPage.jsx"
click node_adminui "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/admin/ManageUsersPage.jsx"
click node_clientstate "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/store/slices/applicationsSlice.js"
click node_api_client "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/services/api.js"
click node_live_client "https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/hooks/useSocket.js"
click node_server "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/app.js"
click node_application_routes "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/routes/application.routes.js"
click node_user_routes "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/routes/user.routes.js"
click node_application_logic "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/application.controller.js"
click node_user_logic "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/user.controller.js"
click node_admin_logic "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/admin.controller.js"
click node_other_domains "https://github.com/animation-tech-253/fyp/tree/dev/backend/src/controllers"
click node_models "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/models/index.js"
click node_notifications "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/socket/index.js"
click node_email "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/services/applicationEmail.service.js"
click node_pdf "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/utils/pdfGenerator.js"
click node_cloud "https://github.com/animation-tech-253/fyp/blob/dev/backend/src/utils/cloudinary.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_web,node_submit,node_review,node_adminui,node_clientstate,node_api_client,node_live_client,node_people toneBlue
class node_server,node_application_routes,node_user_routes toneAmber
class node_application_logic,node_user_logic,node_admin_logic,node_other_domains,node_models toneMint
class node_notifications,node_email,node_pdf,node_cloud toneRose
class node_mail_provider,node_cloudinary_service toneIndigo
```

## Components

### Role Workspaces

- [Role-based app](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Student submission](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/student/SubmitApplicationPage.jsx): `frontend/src/pages/student/SubmitApplicationPage.jsx`
- [Review workspaces](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/hod/HODReviewPage.jsx): `frontend/src/pages/hod/HODReviewPage.jsx`
- [Admin workspace](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/pages/admin/ManageUsersPage.jsx): `frontend/src/pages/admin/ManageUsersPage.jsx`
- [Client state](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/store/slices/applicationsSlice.js): `frontend/src/store/slices/applicationsSlice.js`
- [HTTP client](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/services/api.js): `frontend/src/services/api.js`
- [Socket client](https://github.com/animation-tech-253/fyp/blob/dev/frontend/src/hooks/useSocket.js): `frontend/src/hooks/useSocket.js`

### Backend API

- [Express API](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/app.js): `backend/src/app.js`
- [Application routes](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/routes/application.routes.js): `backend/src/routes/application.routes.js`
- [User routes](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/routes/user.routes.js): `backend/src/routes/user.routes.js`

### Application Domain

- [Application workflow](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/application.controller.js): `backend/src/controllers/application.controller.js`
- [User administration](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/user.controller.js): `backend/src/controllers/user.controller.js`
- [Admin operations](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/controllers/admin.controller.js): `backend/src/controllers/admin.controller.js`
- [Other domain APIs](https://github.com/animation-tech-253/fyp/tree/dev/backend/src/controllers): `backend/src/controllers`
- [Mongo models](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/models/index.js): `backend/src/models/index.js`

### Live and Integrations

- [Live notifications](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/socket/index.js): `backend/src/socket/index.js`
- [Application email](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/services/applicationEmail.service.js): `backend/src/services/applicationEmail.service.js`
- [PDF export](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/utils/pdfGenerator.js): `backend/src/utils/pdfGenerator.js`
- [Profile image storage](https://github.com/animation-tech-253/fyp/blob/dev/backend/src/utils/cloudinary.js): `backend/src/utils/cloudinary.js`

### Other components

- **University users**
- **Email service**
- **Cloudinary**

## Connections

- University users → Role-based app: use (evidence: `frontend/src/App.jsx`)
- Role-based app → Student submission: routes to (evidence: `frontend/src/App.jsx`)
- Role-based app → Review workspaces: routes to (evidence: `frontend/src/App.jsx`)
- Role-based app → Admin workspace: routes to (evidence: `frontend/src/App.jsx`)
- Student submission → Client state: dispatches (evidence: `frontend/src/pages/student/SubmitApplicationPage.jsx`)
- Review workspaces → Client state: dispatches (evidence: `frontend/src/pages/hod/HODReviewPage.jsx`)
- Client state → HTTP client: requests (evidence: `frontend/src/store/slices/applicationsSlice.js`)
- HTTP client → Express API: HTTP calls
- Express API → Application routes: mounts (evidence: `backend/src/app.js`)
- Express API → User routes: mounts (evidence: `backend/src/app.js`)
- Application routes → Application workflow: routes requests (evidence: `backend/src/routes/application.routes.js`)
- User routes → User administration: routes requests (evidence: `backend/src/routes/user.routes.js`)
- Application workflow → Mongo models: reads and writes (evidence: `backend/src/controllers/application.controller.js`)
- User administration → Mongo models: reads and writes (evidence: `backend/src/controllers/user.controller.js`)
- Application workflow → Live notifications: emits events (evidence: `backend/src/controllers/application.controller.js`)
- Application workflow → Application email: sends mail (evidence: `backend/src/controllers/application.controller.js`)
- Application workflow → PDF export: generates export (evidence: `backend/src/controllers/application.controller.js`)
- User administration → Profile image storage: uploads images (evidence: `backend/src/controllers/user.controller.js`)
- Profile image storage → Cloudinary: stores files
- Application email → Email service: delivers mail
- Socket client → Client state: updates state (evidence: `frontend/src/hooks/useSocket.js`)
- Live notifications → Socket client: pushes events
- Admin operations → Mongo models: uses models (evidence: `backend/src/controllers/admin.controller.js`)
- Express API → Other domain APIs: mounts domain APIs (evidence: `backend/src/app.js`)
