# parthsabhaya18/nexity-backend architecture

> Architecture diagram of the GitHub repository parthsabhaya18/nexity-backend, 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/parthsabhaya18/nexity-backend
- Repository: https://github.com/parthsabhaya18/nexity-backend

## Overview

Nexity Backend is an Express REST API. Its principal workflow accepts an HTTP request, routes it to a feature controller, validates and executes authentication logic, accesses MongoDB-backed models, and returns a response; OTP email supports verification and password recovery. The visible implementation centers on authentication, user accounts, and health/readiness checks rather than the broader social-app features described in documentation. Relationships reflect the README and source-index references; unsampled modules are represented only where their wiring is evidenced.

Main entry points: [`src/modules/auth/auth.service.ts`](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.service.ts) (Auth workflows), [`src/modules/auth/otp.service.ts`](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/otp.service.ts) (OTP service), [`src/app.ts`](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/app.ts) (Express app), [`src/routes/index.ts`](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/routes/index.ts) (API router)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_http["HTTP runtime"]
  node_server["Server lifecycle<br/>[server.ts]"]
  node_app["Express app<br/>[app.ts]"]
  node_routing["API router<br/>[index.ts]"]
  node_errors["Error handling<br/>[errorHandler.ts]"]
end

subgraph group_identity["Identity and sessions"]
  node_auth_routes["Auth routes<br/>[auth.routes.ts]"]
  node_auth_controller["Auth controller<br/>[auth.controller.ts]"]
  node_auth_schema["Auth validation<br/>[auth.schema.ts]"]
  node_auth_service["Auth workflows<br/>[auth.service.ts]"]
  node_otp["OTP service<br/>[otp.service.ts]"]
  node_tokens["Token service<br/>[tokens.ts]"]
  node_auth_guard["Auth middleware<br/>[requireAuth.ts]"]
end

subgraph group_persistence["Persistence"]
  node_users[("User model<br/>[user.model.ts]")]
  node_refresh_tokens[("Refresh token model")]
  node_otp_codes[("OTP code model<br/>[otpCode.model.ts]")]
  node_database["MongoDB connection<br/>[database.ts]"]
  node_health_store[("Health check model")]
end

subgraph group_operations["Health and messaging"]
  node_health_routes["Health routes<br/>[health.routes.ts]"]
  node_health_controller["Health checks"]
  node_mailer["Mail delivery<br/>[mailer.ts]"]
  node_email_layout["OTP email layout<br/>[emailLayout.ts]"]
end

node_client(("API client"))
node_smtp["SMTP service"]

node_client -->|"sends requests"| node_app
node_server -->|"connects before listening"| node_database
node_server -->|"creates and serves"| node_app
node_app -->|"mounts routes"| node_routing
node_app -->|"registers handlers"| node_errors
node_routing -->|"mounts router"| node_auth_routes
node_routing -->|"mounts router"| node_health_routes
node_auth_routes -->|"dispatches requests"| node_auth_controller
node_auth_controller -->|"validates input"| node_auth_schema
node_auth_controller -->|"calls workflows"| node_auth_service
node_auth_service -->|"reads and writes"| node_users
node_auth_service -->|"requests codes"| node_otp
node_auth_service -->|"issues and revokes"| node_tokens
node_tokens -->|"stores sessions"| node_refresh_tokens
node_otp -->|"stores codes"| node_otp_codes
node_otp -->|"renders email"| node_email_layout
node_otp -->|"sends email"| node_mailer
node_mailer -.->|"delivers through"| node_smtp
node_auth_guard -->|"verifies tokens"| node_tokens
node_auth_guard -->|"loads user"| node_users
node_health_routes -->|"dispatches checks"| node_health_controller
node_health_controller -->|"checks connection"| node_database
node_health_controller -->|"reads and writes checks"| node_health_store

click node_server "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/server.ts"
click node_app "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/app.ts"
click node_routing "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/routes/index.ts"
click node_errors "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/middlewares/errorHandler.ts"
click node_auth_routes "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.routes.ts"
click node_auth_controller "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.controller.ts"
click node_auth_schema "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.schema.ts"
click node_auth_service "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.service.ts"
click node_otp "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/otp.service.ts"
click node_tokens "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/tokens.ts"
click node_auth_guard "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/middlewares/requireAuth.ts"
click node_users "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/users/user.model.ts"
click node_refresh_tokens "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/refreshToken.model.ts"
click node_otp_codes "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/otpCode.model.ts"
click node_database "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/config/database.ts"
click node_health_routes "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/health.routes.ts"
click node_health_controller "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/health.controller.ts"
click node_health_store "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/healthCheck.model.ts"
click node_mailer "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/utils/mailer.ts"
click node_email_layout "https://github.com/parthsabhaya18/nexity-backend/blob/main/src/utils/emailLayout.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_server,node_app,node_routing,node_errors,node_client toneBlue
class node_auth_routes,node_auth_controller,node_auth_schema,node_auth_service,node_otp,node_tokens,node_auth_guard toneAmber
class node_users,node_refresh_tokens,node_otp_codes,node_database,node_health_store toneMint
class node_health_routes,node_health_controller,node_mailer,node_email_layout toneRose
class node_smtp toneIndigo
```

## Components

### HTTP runtime

- [Server lifecycle](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/server.ts): `src/server.ts`
- [Express app](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/app.ts): `src/app.ts`
- [API router](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/routes/index.ts): `src/routes/index.ts`
- [Error handling](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/middlewares/errorHandler.ts): `src/middlewares/errorHandler.ts`

### Identity and sessions

- [Auth routes](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.routes.ts): `src/modules/auth/auth.routes.ts`
- [Auth controller](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.controller.ts): `src/modules/auth/auth.controller.ts`
- [Auth validation](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.schema.ts): `src/modules/auth/auth.schema.ts`
- [Auth workflows](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/auth.service.ts): `src/modules/auth/auth.service.ts`
- [OTP service](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/otp.service.ts): `src/modules/auth/otp.service.ts`
- [Token service](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/tokens.ts): `src/modules/auth/tokens.ts`
- [Auth middleware](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/middlewares/requireAuth.ts): `src/middlewares/requireAuth.ts`

### Persistence

- [User model](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/users/user.model.ts): `src/modules/users/user.model.ts`
- [Refresh token model](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/refreshToken.model.ts): `src/modules/auth/refreshToken.model.ts`
- [OTP code model](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/auth/otpCode.model.ts): `src/modules/auth/otpCode.model.ts`
- [MongoDB connection](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/config/database.ts): `src/config/database.ts`
- [Health check model](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/healthCheck.model.ts): `src/modules/health/healthCheck.model.ts`

### Health and messaging

- [Health routes](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/health.routes.ts): `src/modules/health/health.routes.ts`
- [Health checks](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/modules/health/health.controller.ts): `src/modules/health/health.controller.ts`
- [Mail delivery](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/utils/mailer.ts): `src/utils/mailer.ts`
- [OTP email layout](https://github.com/parthsabhaya18/nexity-backend/blob/main/src/utils/emailLayout.ts): `src/utils/emailLayout.ts`

### Other components

- **API client**
- **SMTP service**

## Connections

- API client → Express app: sends requests (evidence: `README.md`)
- Server lifecycle → MongoDB connection: connects before listening (evidence: `src/server.ts`)
- Server lifecycle → Express app: creates and serves (evidence: `src/server.ts`)
- Express app → API router: mounts routes (evidence: `src/app.ts`)
- Express app → Error handling: registers handlers (evidence: `src/app.ts`)
- API router → Auth routes: mounts router (evidence: `src/routes/index.ts`)
- API router → Health routes: mounts router (evidence: `src/routes/index.ts`)
- Auth routes → Auth controller: dispatches requests (evidence: `src/modules/auth/auth.routes.ts`)
- Auth controller → Auth validation: validates input (evidence: `src/modules/auth/auth.controller.ts`)
- Auth controller → Auth workflows: calls workflows (evidence: `src/modules/auth/auth.controller.ts`)
- Auth workflows → User model: reads and writes (evidence: `src/modules/auth/auth.service.ts`)
- Auth workflows → OTP service: requests codes (evidence: `src/modules/auth/auth.service.ts`)
- Auth workflows → Token service: issues and revokes (evidence: `src/modules/auth/auth.service.ts`)
- Token service → Refresh token model: stores sessions (evidence: `src/modules/auth/tokens.ts`)
- OTP service → OTP code model: stores codes (evidence: `src/modules/auth/otp.service.ts`)
- OTP service → OTP email layout: renders email (evidence: `src/modules/auth/otp.service.ts`)
- OTP service → Mail delivery: sends email (evidence: `src/modules/auth/otp.service.ts`)
- Mail delivery → SMTP service: delivers through (evidence: `README.md`)
- Auth middleware → Token service: verifies tokens (evidence: `src/middlewares/requireAuth.ts`)
- Auth middleware → User model: loads user (evidence: `src/middlewares/requireAuth.ts`)
- Health routes → Health checks: dispatches checks (evidence: `src/modules/health/health.routes.ts`)
- Health checks → MongoDB connection: checks connection (evidence: `src/modules/health/health.controller.ts`)
- Health checks → Health check model: reads and writes checks (evidence: `src/modules/health/health.controller.ts`)
