# quang-lam1412/twitterprojectk18f2 architecture

> Architecture diagram of the GitHub repository quang-lam1412/twitterprojectk18f2, 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/quang-lam1412/twitterprojectk18f2
- Repository: https://github.com/quang-lam1412/twitterprojectk18f2

## Overview

This is an Express/MongoDB user-account API. Requests enter the user routes, pass endpoint-specific validation and authentication, reach controllers, and are handled by user services that issue tokens and read or update account data. Its domain stages include registration/login, email verification, password recovery, and profile access or updates. The database service supplies MongoDB collections; JWT, password-hashing, request-validation, and error-handling utilities support the API. The README is empty, so capability coverage comes from the routes and sampled source; unsampled startup and middleware details are limited to indexed references.

Main entry points: [`src/middlewares/users.middlewares.ts`](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/users.middlewares.ts) (Input validation), [`src/services/users.services.ts`](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/users.services.ts) (Account services), [`src/services/database.services.ts`](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/database.services.ts) (MongoDB service), [`src/controllers/users.controllers.ts`](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/controllers/users.controllers.ts) (User controllers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API entry"]
  node_server["Server startup<br/>[index.ts]"]
  node_routes["User routes<br/>[users.routes.ts]"]
  node_common["Request filtering"]
  node_validation["Input validation"]
  node_errors["Error handling"]
  node_controllers["User controllers"]
end

subgraph group_identity["Identity workflows"]
  node_user_service["Account services<br/>[users.services.ts]"]
end

subgraph group_profiles["Profile workflows"]
end

subgraph group_internals["Persistence and utilities"]
  node_user_schema["User records<br/>[User.schema.ts]"]
  node_refresh_schema["Refresh-token records"]
  node_database["MongoDB service"]
  node_crypto["Password hashing<br/>[crypto.ts]"]
  node_jwt["JWT utilities<br/>[jwt.ts]"]
  node_request_types["Request types<br/>[User.requests.ts]"]
  node_error_types["API error types<br/>[Errors.ts]"]
  node_validation_util["Validation utility<br/>[validation.ts]"]
  node_async_handler["Async handler<br/>[handlers.ts]"]
  node_enums["Account enums<br/>[enums.ts]"]
  node_messages["User messages<br/>[message.ts]"]
  node_http_status["HTTP statuses<br/>[httpStatus.ts]"]
end

node_client(("API client"))
node_mongo[("MongoDB")]

node_client -->|"sends requests"| node_server
node_server -->|"mounts routes"| node_routes
node_server -->|"connects"| node_database
node_server -->|"registers handler"| node_errors
node_routes -->|"dispatches"| node_controllers
node_routes -->|"validates requests"| node_validation
node_routes -->|"filters fields"| node_common
node_routes -->|"wraps handlers"| node_async_handler
node_controllers -->|"calls account logic"| node_user_service
node_controllers -->|"reads user records"| node_database
node_validation -->|"checks records"| node_database
node_validation -->|"checks email"| node_user_service
node_validation -->|"hashes passwords"| node_crypto
node_validation -->|"verifies tokens"| node_jwt
node_validation -->|"uses validator"| node_validation_util
node_user_service -->|"reads and writes"| node_database
node_user_service -->|"hashes passwords"| node_crypto
node_user_service -->|"signs tokens"| node_jwt
node_database -->|"queries"| node_mongo
node_database -->|"types collection"| node_user_schema
node_database -->|"types collection"| node_refresh_schema
node_user_schema -->|"uses status"| node_enums
node_controllers -->|"types requests"| node_request_types
node_validation -->|"raises errors"| node_error_types
node_errors -->|"formats errors"| node_error_types
node_validation_util -->|"raises validation errors"| node_error_types
node_user_service -->|"raises account errors"| node_error_types
node_controllers -->|"returns messages"| node_messages
node_controllers -->|"sets statuses"| node_http_status
node_validation -->|"uses messages"| node_messages
node_validation -->|"sets error status"| node_http_status
node_user_service -->|"returns messages"| node_messages
node_user_service -->|"sets error status"| node_http_status

click node_server "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/index.ts"
click node_routes "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/routes/users.routes.ts"
click node_common "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/common.middleware.ts"
click node_validation "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/users.middlewares.ts"
click node_errors "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/error.middlewares.ts"
click node_controllers "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/controllers/users.controllers.ts"
click node_user_service "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/users.services.ts"
click node_user_schema "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/schemas/User.schema.ts"
click node_refresh_schema "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/schemas/RefreshToken.schema.ts"
click node_database "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/database.services.ts"
click node_crypto "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/crypto.ts"
click node_jwt "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/jwt.ts"
click node_request_types "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/requests/User.requests.ts"
click node_error_types "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/Errors.ts"
click node_validation_util "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/validation.ts"
click node_async_handler "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/handlers.ts"
click node_enums "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/enums.ts"
click node_messages "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/message.ts"
click node_http_status "https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/httpStatus.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_routes,node_common,node_validation,node_errors,node_controllers,node_client toneBlue
class node_user_service,node_mongo toneAmber
class node_user_schema,node_refresh_schema,node_database,node_crypto,node_jwt,node_request_types,node_error_types,node_validation_util,node_async_handler,node_enums,node_messages,node_http_status toneRose
```

## Components

### API entry

- [Server startup](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/index.ts): `src/index.ts`
- [User routes](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/routes/users.routes.ts): `src/routes/users.routes.ts`
- [Request filtering](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/common.middleware.ts): `src/middlewares/common.middleware.ts`
- [Input validation](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/users.middlewares.ts): `src/middlewares/users.middlewares.ts`
- [Error handling](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/middlewares/error.middlewares.ts): `src/middlewares/error.middlewares.ts`
- [User controllers](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/controllers/users.controllers.ts): `src/controllers/users.controllers.ts`

### Identity workflows

- [Account services](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/users.services.ts): `src/services/users.services.ts`

### Persistence and utilities

- [User records](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/schemas/User.schema.ts): `src/models/schemas/User.schema.ts`
- [Refresh-token records](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/schemas/RefreshToken.schema.ts): `src/models/schemas/RefreshToken.schema.ts`
- [MongoDB service](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/services/database.services.ts): `src/services/database.services.ts`
- [Password hashing](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/crypto.ts): `src/utils/crypto.ts`
- [JWT utilities](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/jwt.ts): `src/utils/jwt.ts`
- [Request types](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/requests/User.requests.ts): `src/models/requests/User.requests.ts`
- [API error types](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/models/Errors.ts): `src/models/Errors.ts`
- [Validation utility](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/validation.ts): `src/utils/validation.ts`
- [Async handler](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/utils/handlers.ts): `src/utils/handlers.ts`
- [Account enums](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/enums.ts): `src/constants/enums.ts`
- [User messages](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/message.ts): `src/constants/message.ts`
- [HTTP statuses](https://github.com/quang-lam1412/twitterprojectk18f2/blob/main/src/constants/httpStatus.ts): `src/constants/httpStatus.ts`

### Other components

- **API client**
- **MongoDB**

## Connections

- API client → Server startup: sends requests (evidence: `src/index.ts`)
- Server startup → User routes: mounts routes (evidence: `src/index.ts`)
- Server startup → MongoDB service: connects (evidence: `src/index.ts`)
- Server startup → Error handling: registers handler (evidence: `src/index.ts`)
- User routes → User controllers: dispatches (evidence: `src/routes/users.routes.ts`)
- User routes → Input validation: validates requests (evidence: `src/routes/users.routes.ts`)
- User routes → Request filtering: filters fields (evidence: `src/routes/users.routes.ts`)
- User routes → Async handler: wraps handlers (evidence: `src/routes/users.routes.ts`)
- User controllers → Account services: calls account logic (evidence: `src/controllers/users.controllers.ts`)
- User controllers → MongoDB service: reads user records (evidence: `src/controllers/users.controllers.ts`)
- Input validation → MongoDB service: checks records (evidence: `src/middlewares/users.middlewares.ts`)
- Input validation → Account services: checks email (evidence: `src/middlewares/users.middlewares.ts`)
- Input validation → Password hashing: hashes passwords (evidence: `src/middlewares/users.middlewares.ts`)
- Input validation → JWT utilities: verifies tokens (evidence: `src/middlewares/users.middlewares.ts`)
- Input validation → Validation utility: uses validator (evidence: `src/middlewares/users.middlewares.ts`)
- Account services → MongoDB service: reads and writes (evidence: `src/services/users.services.ts`)
- Account services → Password hashing: hashes passwords (evidence: `src/services/users.services.ts`)
- Account services → JWT utilities: signs tokens (evidence: `src/services/users.services.ts`)
- MongoDB service → MongoDB: queries (evidence: `src/services/database.services.ts`)
- MongoDB service → User records: types collection (evidence: `src/services/database.services.ts`)
- MongoDB service → Refresh-token records: types collection (evidence: `src/services/database.services.ts`)
- User records → Account enums: uses status (evidence: `src/models/schemas/User.schema.ts`)
- User controllers → Request types: types requests (evidence: `src/controllers/users.controllers.ts`)
- Input validation → API error types: raises errors (evidence: `src/middlewares/users.middlewares.ts`)
- Error handling → API error types: formats errors (evidence: `src/middlewares/error.middlewares.ts`)
- Validation utility → API error types: raises validation errors (evidence: `src/utils/validation.ts`)
- Account services → API error types: raises account errors (evidence: `src/services/users.services.ts`)
- User controllers → User messages: returns messages (evidence: `src/controllers/users.controllers.ts`)
- User controllers → HTTP statuses: sets statuses (evidence: `src/controllers/users.controllers.ts`)
- Input validation → User messages: uses messages (evidence: `src/middlewares/users.middlewares.ts`)
- Input validation → HTTP statuses: sets error status (evidence: `src/middlewares/users.middlewares.ts`)
- Account services → User messages: returns messages (evidence: `src/services/users.services.ts`)
- Account services → HTTP statuses: sets error status (evidence: `src/services/users.services.ts`)
