# yxsh-codes/ai-resume-analyser architecture

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

- Interactive diagram: https://gitdiagram.com/yxsh-codes/ai-resume-analyser
- Repository: https://github.com/yxsh-codes/ai-resume-analyser

## Overview

This is a full-stack AI resume-analysis and interview-preparation platform. Users authenticate, submit resume and job information, then receive interview reports, browse saved reports, and download generated resumes. The README also documents ATS insights and resume/job matching, though the sampled implementation does not establish their detailed runtime flow. Frontend-to-backend HTTP wiring and AI-provider calls are not visible in the excerpts, so those links are marked unverified.

Main entry points: [`Frontend/src/app.routes.jsx`](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/app.routes.jsx) (Page routing), [`Frontend/src/features/auth/hooks/useAuth.js`](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/hooks/useAuth.js) (Auth actions), [`Frontend/src/features/interview/hooks/useInterview.js`](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/hooks/useInterview.js) (Report actions), [`Backend/src/routes/auth.routes.js`](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/routes/auth.routes.js) (Auth routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Web application"]
  node_app["Application shell<br/>[App.jsx]"]
  node_routing["Page routing<br/>[app.routes.jsx]"]
end

subgraph group_auth["Authentication"]
  node_login["Login page<br/>[Login.jsx]"]
  node_register["Registration page<br/>[Register.jsx]"]
  node_authstate["Auth state<br/>[auth.context.jsx]"]
  node_authhook["Auth actions<br/>[useAuth.js]"]
  node_authapi["Auth API client<br/>[auth.api.js]"]
  node_protected["Route guard<br/>[Protected.jsx]"]
end

subgraph group_interviews["Interview workflow"]
  node_home["Report dashboard<br/>[Home.jsx]"]
  node_interviewpage["Interview report view<br/>[Interview.jsx]"]
  node_interviewstate["Interview state"]
  node_interviewhook["Report actions<br/>[useInterview.js]"]
  node_interviewapi["Interview API client<br/>[interview.api.js]"]
end

subgraph group_backend["Backend API"]
  node_api["Express API<br/>[app.js]"]
  node_authroutes["Auth routes<br/>[auth.routes.js]"]
  node_interviewroutes["Interview routes"]
  node_authcontroller["Auth operations<br/>[auth.controller.js]"]
  node_authmiddleware["Token validation<br/>[auth.middleware.js]"]
  node_interviewcontroller["Report operations"]
  node_ai["AI analysis and PDF<br/>[ai.service.js]"]
end

subgraph group_data["Persistent data"]
  node_database[("MongoDB connection<br/>[database.js]")]
  node_users[("User records<br/>[user.model.js]")]
  node_blacklist[("Token blacklist<br/>[blacklist.model.js]")]
  node_reports[("Interview reports")]
end

node_user(("User"))
node_ai_provider["AI provider"]

node_user -.->|"uses"| node_routing
node_app -->|"mounts"| node_routing
node_app -->|"provides"| node_authstate
node_app -->|"provides"| node_interviewstate
node_routing -->|"routes to"| node_login
node_routing -->|"routes to"| node_register
node_routing -->|"guards"| node_protected
node_routing -->|"routes to"| node_home
node_routing -->|"routes to"| node_interviewpage
node_login -->|"uses"| node_authhook
node_register -->|"uses"| node_authhook
node_authhook -->|"updates"| node_authstate
node_authhook -->|"calls"| node_authapi
node_protected -->|"checks"| node_authhook
node_home -->|"uses"| node_interviewhook
node_interviewpage -->|"uses"| node_interviewhook
node_interviewhook -->|"updates"| node_interviewstate
node_interviewhook -->|"calls"| node_interviewapi
node_authapi -.->|"HTTP calls"| node_authroutes
node_interviewapi -.->|"HTTP calls"| node_interviewroutes
node_api -->|"mounts"| node_authroutes
node_api -->|"mounts"| node_interviewroutes
node_authroutes -->|"dispatches"| node_authcontroller
node_authroutes -->|"protects"| node_authmiddleware
node_interviewroutes -->|"protects"| node_authmiddleware
node_interviewroutes -->|"dispatches"| node_interviewcontroller
node_authcontroller -->|"reads/writes"| node_users
node_authcontroller -->|"records logout"| node_blacklist
node_authmiddleware -->|"checks"| node_blacklist
node_interviewcontroller -->|"requests analysis"| node_ai
node_interviewcontroller -->|"reads/writes"| node_reports
node_ai -.->|"uses provider"| node_ai_provider
node_api -->|"connects"| node_database

click node_app "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/App.jsx"
click node_routing "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/app.routes.jsx"
click node_login "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/pages/Login.jsx"
click node_register "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/pages/Register.jsx"
click node_authstate "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/auth.context.jsx"
click node_authhook "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/hooks/useAuth.js"
click node_authapi "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/services/auth.api.js"
click node_protected "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/components/Protected.jsx"
click node_home "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/pages/Home.jsx"
click node_interviewpage "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/pages/Interview.jsx"
click node_interviewstate "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/interview.context.jsx"
click node_interviewhook "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/hooks/useInterview.js"
click node_interviewapi "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/services/interview.api.js"
click node_api "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/app.js"
click node_authroutes "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/routes/auth.routes.js"
click node_interviewroutes "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/routes/interview.routes.js"
click node_authcontroller "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/controllers/auth.controller.js"
click node_authmiddleware "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/middlewares/auth.middleware.js"
click node_interviewcontroller "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/controllers/interview.controller.js"
click node_ai "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/services/ai.service.js"
click node_database "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/config/database.js"
click node_users "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/user.model.js"
click node_blacklist "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/blacklist.model.js"
click node_reports "https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/interviewReport.model.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_app,node_routing,node_user toneBlue
class node_login,node_register,node_authstate,node_authhook,node_authapi,node_protected toneAmber
class node_home,node_interviewpage,node_interviewstate,node_interviewhook,node_interviewapi toneMint
class node_api,node_authroutes,node_interviewroutes,node_authcontroller,node_authmiddleware,node_interviewcontroller,node_ai toneRose
class node_database,node_users,node_blacklist,node_reports,node_ai_provider toneIndigo
```

## Components

### Web application

- [Application shell](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/App.jsx): `Frontend/src/App.jsx`
- [Page routing](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/app.routes.jsx): `Frontend/src/app.routes.jsx`

### Authentication

- [Login page](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/pages/Login.jsx): `Frontend/src/features/auth/pages/Login.jsx`
- [Registration page](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/pages/Register.jsx): `Frontend/src/features/auth/pages/Register.jsx`
- [Auth state](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/auth.context.jsx): `Frontend/src/features/auth/auth.context.jsx`
- [Auth actions](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/hooks/useAuth.js): `Frontend/src/features/auth/hooks/useAuth.js`
- [Auth API client](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/services/auth.api.js): `Frontend/src/features/auth/services/auth.api.js`
- [Route guard](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/auth/components/Protected.jsx): `Frontend/src/features/auth/components/Protected.jsx`

### Interview workflow

- [Report dashboard](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/pages/Home.jsx): `Frontend/src/features/interview/pages/Home.jsx`
- [Interview report view](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/pages/Interview.jsx): `Frontend/src/features/interview/pages/Interview.jsx`
- [Interview state](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/interview.context.jsx): `Frontend/src/features/interview/interview.context.jsx`
- [Report actions](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/hooks/useInterview.js): `Frontend/src/features/interview/hooks/useInterview.js`
- [Interview API client](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Frontend/src/features/interview/services/interview.api.js): `Frontend/src/features/interview/services/interview.api.js`

### Backend API

- [Express API](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/app.js): `Backend/src/app.js`
- [Auth routes](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/routes/auth.routes.js): `Backend/src/routes/auth.routes.js`
- [Interview routes](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/routes/interview.routes.js): `Backend/src/routes/interview.routes.js`
- [Auth operations](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/controllers/auth.controller.js): `Backend/src/controllers/auth.controller.js`
- [Token validation](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/middlewares/auth.middleware.js): `Backend/src/middlewares/auth.middleware.js`
- [Report operations](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/controllers/interview.controller.js): `Backend/src/controllers/interview.controller.js`
- [AI analysis and PDF](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/services/ai.service.js): `Backend/src/services/ai.service.js`

### Persistent data

- [MongoDB connection](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/config/database.js): `Backend/src/config/database.js`
- [User records](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/user.model.js): `Backend/src/models/user.model.js`
- [Token blacklist](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/blacklist.model.js): `Backend/src/models/blacklist.model.js`
- [Interview reports](https://github.com/yxsh-codes/ai-resume-analyser/blob/main/Backend/src/models/interviewReport.model.js): `Backend/src/models/interviewReport.model.js`

### Other components

- **User**
- **AI provider**

## Connections

- User → Page routing: uses (evidence: `README.md`)
- Application shell → Page routing: mounts (evidence: `Frontend/src/App.jsx`)
- Application shell → Auth state: provides (evidence: `Frontend/src/App.jsx`)
- Application shell → Interview state: provides (evidence: `Frontend/src/App.jsx`)
- Page routing → Login page: routes to (evidence: `Frontend/src/app.routes.jsx`)
- Page routing → Registration page: routes to (evidence: `Frontend/src/app.routes.jsx`)
- Page routing → Route guard: guards (evidence: `Frontend/src/app.routes.jsx`)
- Page routing → Report dashboard: routes to (evidence: `Frontend/src/app.routes.jsx`)
- Page routing → Interview report view: routes to (evidence: `Frontend/src/app.routes.jsx`)
- Login page → Auth actions: uses (evidence: `Frontend/src/features/auth/pages/Login.jsx`)
- Registration page → Auth actions: uses (evidence: `Frontend/src/features/auth/pages/Register.jsx`)
- Auth actions → Auth state: updates (evidence: `Frontend/src/features/auth/hooks/useAuth.js`)
- Auth actions → Auth API client: calls (evidence: `Frontend/src/features/auth/hooks/useAuth.js`)
- Route guard → Auth actions: checks (evidence: `Frontend/src/features/auth/components/Protected.jsx`)
- Report dashboard → Report actions: uses (evidence: `Frontend/src/features/interview/pages/Home.jsx`)
- Interview report view → Report actions: uses (evidence: `Frontend/src/features/interview/pages/Interview.jsx`)
- Report actions → Interview state: updates (evidence: `Frontend/src/features/interview/hooks/useInterview.js`)
- Report actions → Interview API client: calls (evidence: `Frontend/src/features/interview/hooks/useInterview.js`)
- Auth API client → Auth routes: HTTP calls
- Interview API client → Interview routes: HTTP calls
- Express API → Auth routes: mounts (evidence: `Backend/src/app.js`)
- Express API → Interview routes: mounts (evidence: `Backend/src/app.js`)
- Auth routes → Auth operations: dispatches (evidence: `Backend/src/routes/auth.routes.js`)
- Auth routes → Token validation: protects (evidence: `Backend/src/routes/auth.routes.js`)
- Interview routes → Token validation: protects (evidence: `Backend/src/routes/interview.routes.js`)
- Interview routes → Report operations: dispatches (evidence: `Backend/src/routes/interview.routes.js`)
- Auth operations → User records: reads/writes (evidence: `Backend/src/controllers/auth.controller.js`)
- Auth operations → Token blacklist: records logout (evidence: `Backend/src/controllers/auth.controller.js`)
- Token validation → Token blacklist: checks (evidence: `Backend/src/middlewares/auth.middleware.js`)
- Report operations → AI analysis and PDF: requests analysis (evidence: `Backend/src/controllers/interview.controller.js`)
- Report operations → Interview reports: reads/writes (evidence: `Backend/src/controllers/interview.controller.js`)
- AI analysis and PDF → AI provider: uses provider (evidence: `README.md`)
- Express API → MongoDB connection: connects (evidence: `Backend/server.js`)
