# akash00173/interview-plan-generator architecture

> Architecture diagram of the GitHub repository akash00173/interview-plan-generator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/akash00173/interview-plan-generator
- Repository: https://github.com/akash00173/interview-plan-generator

## Overview

This is a web app for generating and reviewing AI-assisted interview preparation plans. A candidate registers or logs in, submits a resume or self-description with a job description, and receives a saved report containing a match score, questions, skill gaps, and a preparation plan; reports can be revisited and exported as PDFs. The map includes authentication, report generation, and persistence. The README is empty and several implementation files were not sampled, so some UI-to-hook wiring and route details are not shown; Ollama is an optional AI integration.

Main entry points: [`Frontend/src/App.jsx`](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/App.jsx) (App provider), [`Frontend/src/app.routes.jsx`](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/app.routes.jsx) (Page router), [`Backend/src/controllers/interview.controller.js`](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/interview.controller.js) (Report controller), [`Backend/src/app.js`](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/app.js) (Express API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Candidate web app"]
  node_app["App provider<br/>[App.jsx]"]
  node_routes["Page router<br/>[app.routes.jsx]"]
  node_auth_pages["Login and register"]
  node_home_page["Report dashboard<br/>[home.jsx]"]
  node_interview_page["Report view<br/>[interview.jsx]"]
  node_auth_state["Auth state<br/>[auth.context.jsx]"]
  node_auth_hook["Auth actions<br/>[useAuth.js]"]
  node_interview_state["Interview state"]
  node_interview_hook["Report actions<br/>[useInterview.js]"]
  node_auth_client["Auth API client<br/>[auth.api.js]"]
  node_interview_client["Interview API client<br/>[interview.api.js]"]
end

subgraph group_backend["API and authentication"]
  node_api["Express API<br/>[app.js]"]
  node_auth_routes["Auth routes<br/>[auth.routes.js]"]
  node_interview_routes["Interview routes<br/>[interview.route.js]"]
  node_auth_controller["Auth controller<br/>[auth.controller.js]"]
  node_auth_middleware["Token middleware<br/>[auth.middleware.js]"]
end

subgraph group_reports["Interview preparation"]
  node_interview_controller["Report controller"]
  node_ai_service["Report generation<br/>[ai.service.js]"]
  node_pdf_output["PDF export"]
end

subgraph group_storage["Persistent data"]
  node_user_model[("User records<br/>[user.model.js]")]
  node_blacklist_model[("Token blacklist<br/>[blacklist.model.js]")]
  node_report_model[("Interview reports")]
end

node_candidate(("Candidate"))
node_mongo[("MongoDB")]
node_ollama["Ollama service"]

node_candidate -->|"uses"| node_app
node_app -->|"provides routes"| node_routes
node_routes -->|"routes to"| node_auth_pages
node_routes -->|"routes to"| node_home_page
node_routes -->|"routes to"| node_interview_page
node_app -->|"provides state"| node_auth_state
node_app -->|"provides state"| node_interview_state
node_auth_hook -->|"updates"| node_auth_state
node_auth_hook -->|"calls"| node_auth_client
node_interview_hook -->|"updates"| node_interview_state
node_interview_hook -->|"calls"| node_interview_client
node_auth_client -->|"requests"| node_api
node_interview_client -->|"requests"| node_api
node_api -->|"mounts"| node_auth_routes
node_api -->|"mounts"| node_interview_routes
node_auth_routes -->|"dispatches"| node_auth_controller
node_auth_routes -->|"guards"| node_auth_middleware
node_auth_middleware -->|"checks token"| node_blacklist_model
node_auth_controller -->|"reads and writes"| node_user_model
node_auth_controller -->|"records logout"| node_blacklist_model
node_interview_routes -->|"dispatches"| node_interview_controller
node_interview_controller -->|"generates report"| node_ai_service
node_interview_controller -->|"creates and reads"| node_report_model
node_interview_controller -->|"renders export"| node_pdf_output
node_ai_service -.->|"queries model"| node_ollama
node_user_model -->|"persists"| node_mongo
node_blacklist_model -->|"persists"| node_mongo
node_report_model -->|"persists"| node_mongo

click node_app "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/App.jsx"
click node_routes "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/app.routes.jsx"
click node_auth_pages "https://github.com/akash00173/interview-plan-generator/tree/main/Frontend/src/features/auth/pages"
click node_home_page "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/pages/home.jsx"
click node_interview_page "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/pages/interview.jsx"
click node_auth_state "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/auth.context.jsx"
click node_auth_hook "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/hooks/useAuth.js"
click node_interview_state "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/interview.context.jsx"
click node_interview_hook "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/hooks/useInterview.js"
click node_auth_client "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/services/auth.api.js"
click node_interview_client "https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/services/interview.api.js"
click node_api "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/app.js"
click node_auth_routes "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/routes/auth.routes.js"
click node_interview_routes "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/routes/interview.route.js"
click node_auth_controller "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/auth.controller.js"
click node_auth_middleware "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/middlewares/auth.middleware.js"
click node_interview_controller "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/interview.controller.js"
click node_ai_service "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/services/ai.service.js"
click node_pdf_output "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/interview.controller.js"
click node_user_model "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/models/user.model.js"
click node_blacklist_model "https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/models/blacklist.model.js"
click node_report_model "https://github.com/akash00173/interview-plan-generator/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_routes,node_auth_pages,node_home_page,node_interview_page,node_auth_state,node_auth_hook,node_interview_state,node_interview_hook,node_auth_client,node_interview_client toneBlue
class node_api,node_auth_routes,node_interview_routes,node_auth_controller,node_auth_middleware,node_mongo toneAmber
class node_interview_controller,node_ai_service,node_pdf_output toneMint
class node_user_model,node_blacklist_model,node_report_model toneRose
class node_candidate,node_ollama toneIndigo
```

## Components

### Candidate web app

- [App provider](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/App.jsx): `Frontend/src/App.jsx`
- [Page router](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/app.routes.jsx): `Frontend/src/app.routes.jsx`
- [Login and register](https://github.com/akash00173/interview-plan-generator/tree/main/Frontend/src/features/auth/pages): `Frontend/src/features/auth/pages`
- [Report dashboard](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/pages/home.jsx): `Frontend/src/features/interview/pages/home.jsx`
- [Report view](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/pages/interview.jsx): `Frontend/src/features/interview/pages/interview.jsx`
- [Auth state](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/auth.context.jsx): `Frontend/src/features/auth/auth.context.jsx`
- [Auth actions](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/hooks/useAuth.js): `Frontend/src/features/interview/hooks/useAuth.js`
- [Interview state](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/interview.context.jsx): `Frontend/src/features/interview/interview.context.jsx`
- [Report actions](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/interview/hooks/useInterview.js): `Frontend/src/features/interview/hooks/useInterview.js`
- [Auth API client](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/services/auth.api.js): `Frontend/src/features/auth/services/auth.api.js`
- [Interview API client](https://github.com/akash00173/interview-plan-generator/blob/main/Frontend/src/features/auth/services/interview.api.js): `Frontend/src/features/auth/services/interview.api.js`

### API and authentication

- [Express API](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/app.js): `Backend/src/app.js`
- [Auth routes](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/routes/auth.routes.js): `Backend/src/routes/auth.routes.js`
- [Interview routes](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/routes/interview.route.js): `Backend/src/routes/interview.route.js`
- [Auth controller](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/auth.controller.js): `Backend/src/controllers/auth.controller.js`
- [Token middleware](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/middlewares/auth.middleware.js): `Backend/src/middlewares/auth.middleware.js`

### Interview preparation

- [Report controller](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/interview.controller.js): `Backend/src/controllers/interview.controller.js`
- [Report generation](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/services/ai.service.js): `Backend/src/services/ai.service.js`
- [PDF export](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/controllers/interview.controller.js): `Backend/src/controllers/interview.controller.js`

### Persistent data

- [User records](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/models/user.model.js): `Backend/src/models/user.model.js`
- [Token blacklist](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/models/blacklist.model.js): `Backend/src/models/blacklist.model.js`
- [Interview reports](https://github.com/akash00173/interview-plan-generator/blob/main/Backend/src/models/interviewReport.model.js): `Backend/src/models/interviewReport.model.js`

### Other components

- **Candidate**
- **MongoDB**
- **Ollama service**

## Connections

- Candidate → App provider: uses
- App provider → Page router: provides routes
- Page router → Login and register: routes to
- Page router → Report dashboard: routes to
- Page router → Report view: routes to
- App provider → Auth state: provides state
- App provider → Interview state: provides state
- Auth actions → Auth state: updates
- Auth actions → Auth API client: calls
- Report actions → Interview state: updates
- Report actions → Interview API client: calls
- Auth API client → Express API: requests
- Interview API client → Express API: requests
- Express API → Auth routes: mounts
- Express API → Interview routes: mounts
- Auth routes → Auth controller: dispatches
- Auth routes → Token middleware: guards
- Token middleware → Token blacklist: checks token
- Auth controller → User records: reads and writes
- Auth controller → Token blacklist: records logout
- Interview routes → Report controller: dispatches
- Report controller → Report generation: generates report
- Report controller → Interview reports: creates and reads
- Report controller → PDF export: renders export
- Report generation → Ollama service: queries model
- User records → MongoDB: persists
- Token blacklist → MongoDB: persists
- Interview reports → MongoDB: persists
