# mohamedsafin/rental-car architecture

> Architecture diagram of the GitHub repository mohamedsafin/rental-car, 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/mohamedsafin/rental-car
- Repository: https://github.com/mohamedsafin/rental-car

## Overview

This is a UAE car-rental platform with a customer booking site, a staff/admin operations dashboard, and an Express API that owns business rules. The customer journey is vehicle search, availability and server-side pricing, booking, payment, then rental handover and return; staff administer the fleet and manage the same lifecycle. The README also documents finance, documents, notifications, legal outputs, and reporting. Connections between sampled routes and services are evidenced by the source index; broader browser-to-API and database relationships follow the README. Some backend subsystems are documented but not sampled, so their internal links are omitted.

Main entry points: [`backend/src/app.ts`](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/app.ts) (API Application), [`backend/src/config/prisma.ts`](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/prisma.ts) (PostgreSQL Data), [`backend/src/modules/bookings/service.ts`](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/bookings/service.ts) (Booking Lifecycle), [`admin/src/services/api.ts`](https://github.com/mohamedsafin/rental-car/blob/main/admin/src/services/api.ts) (Admin API Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_customer["Customer Website"]
  node_web_routes["Customer Pages<br/>[AppRoutes.tsx]"]
  node_web_api["Customer API Client<br/>[api.ts]"]
end

subgraph group_admin["Staff Dashboard"]
  node_admin_routes["Admin Pages<br/>[AppRoutes.tsx]"]
  node_admin_api["Admin API Client<br/>[api.ts]"]
  node_admin_types["Admin API Types<br/>[api.ts]"]
end

subgraph group_business["Rental Operations API"]
  node_api_entry["API Application<br/>[app.ts]"]
  node_booking["Booking Lifecycle<br/>[service.ts]"]
  node_availability["Vehicle Availability<br/>[service.ts]"]
  node_pricing["Pricing Engine<br/>[calculator.ts]"]
  node_fleet["Fleet Operations<br/>[finesService.ts]"]
  node_rentals["Rental Lifecycle<br/>[routes.ts]"]
  node_customers["Customer Profiles<br/>[service.ts]"]
end

subgraph group_governance["Security and Platform"]
  node_authn["Authentication<br/>[authenticate.ts]"]
  node_authz["Role Authorization<br/>[authorize.ts]"]
  node_validation["Request Validation<br/>[validate.ts]"]
  node_audit["Audit Trail<br/>[service.ts]"]
  node_environment["Runtime Config<br/>[env.ts]"]
  node_logging["Logging<br/>[logger.ts]"]
  node_database[("PostgreSQL Data<br/>[prisma.ts]")]
  node_response["API Responses<br/>[apiResponse.ts]"]
  node_async["Async Route Handling<br/>[asyncHandler.ts]"]
  node_upload["Private File Uploads<br/>[upload.ts]"]
  node_error["Error Model<br/>[ApiError.ts]"]
end

subgraph group_outputs["Finance and Outputs"]
  node_payment["Payments and Deposits<br/>[service.ts]"]
  node_settings["Business Settings<br/>[service.ts]"]
  node_documents_reports["Documents and Reports<br/>[service.ts]"]
end

node_renter(("Renter"))
node_staff(("Staff"))

node_renter -->|"uses"| node_web_routes
node_web_routes -.->|"requests through"| node_web_api
node_web_api -.->|"calls API"| node_api_entry
node_staff -->|"uses"| node_admin_routes
node_admin_routes -.->|"requests through"| node_admin_api
node_admin_api -->|"uses types"| node_admin_types
node_admin_api -.->|"calls API"| node_api_entry
node_api_entry -.->|"guards requests"| node_authn
node_api_entry -.->|"guards requests"| node_authz
node_booking -.->|"checks availability"| node_availability
node_booking -.->|"computes price"| node_pricing
node_booking -.->|"persists bookings"| node_database
node_fleet -.->|"reads and writes"| node_database
node_rentals -->|"reads and writes"| node_database
node_rentals -.->|"updates lifecycle"| node_booking
node_customers -.->|"reads and writes"| node_database
node_payment -->|"records payments"| node_database
node_payment -.->|"confirms booking"| node_booking
node_pricing -->|"uses settings"| node_settings
node_documents_reports -.->|"reads records"| node_database
node_api_entry -.->|"validates inputs"| node_validation
node_api_entry -.->|"formats responses"| node_response
node_api_entry -.->|"wraps handlers"| node_async
node_api_entry -.->|"handles failures"| node_error
node_audit -->|"writes audit log"| node_database
node_audit -->|"logs failures"| node_logging
node_database -->|"gets connection config"| node_environment
node_database -->|"logs connection failures"| node_logging
node_api_entry -.->|"accepts files"| node_upload

click node_web_routes "https://github.com/mohamedsafin/rental-car/blob/main/frontend/src/routes/AppRoutes.tsx"
click node_web_api "https://github.com/mohamedsafin/rental-car/blob/main/frontend/src/services/api.ts"
click node_admin_routes "https://github.com/mohamedsafin/rental-car/blob/main/admin/src/routes/AppRoutes.tsx"
click node_admin_api "https://github.com/mohamedsafin/rental-car/blob/main/admin/src/services/api.ts"
click node_admin_types "https://github.com/mohamedsafin/rental-car/blob/main/admin/src/types/api.ts"
click node_api_entry "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/app.ts"
click node_booking "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/bookings/service.ts"
click node_availability "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/availability/service.ts"
click node_pricing "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/pricing/calculator.ts"
click node_fleet "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/fleet/finesService.ts"
click node_rentals "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/rentals/routes.ts"
click node_customers "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/customers/service.ts"
click node_authn "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/authenticate.ts"
click node_authz "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/authorize.ts"
click node_validation "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/validate.ts"
click node_audit "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/audit/service.ts"
click node_environment "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/env.ts"
click node_logging "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/logger.ts"
click node_database "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/prisma.ts"
click node_payment "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/payments/service.ts"
click node_settings "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/settings/service.ts"
click node_documents_reports "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/invoices/service.ts"
click node_response "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/apiResponse.ts"
click node_async "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/asyncHandler.ts"
click node_upload "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/upload.ts"
click node_error "https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/ApiError.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_web_routes,node_web_api toneBlue
class node_admin_routes,node_admin_api,node_admin_types toneAmber
class node_api_entry,node_booking,node_availability,node_pricing,node_fleet,node_rentals,node_customers toneMint
class node_authn,node_authz,node_validation,node_audit,node_environment,node_logging,node_database,node_response,node_async,node_upload,node_error toneRose
class node_payment,node_settings,node_documents_reports,node_renter,node_staff toneIndigo
```

## Components

### Customer Website

- [Customer Pages](https://github.com/mohamedsafin/rental-car/blob/main/frontend/src/routes/AppRoutes.tsx): `frontend/src/routes/AppRoutes.tsx`
- [Customer API Client](https://github.com/mohamedsafin/rental-car/blob/main/frontend/src/services/api.ts): `frontend/src/services/api.ts`

### Staff Dashboard

- [Admin Pages](https://github.com/mohamedsafin/rental-car/blob/main/admin/src/routes/AppRoutes.tsx): `admin/src/routes/AppRoutes.tsx`
- [Admin API Client](https://github.com/mohamedsafin/rental-car/blob/main/admin/src/services/api.ts): `admin/src/services/api.ts`
- [Admin API Types](https://github.com/mohamedsafin/rental-car/blob/main/admin/src/types/api.ts): `admin/src/types/api.ts`

### Rental Operations API

- [API Application](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/app.ts): `backend/src/app.ts`
- [Booking Lifecycle](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/bookings/service.ts): `backend/src/modules/bookings/service.ts`
- [Vehicle Availability](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/availability/service.ts): `backend/src/modules/availability/service.ts`
- [Pricing Engine](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/pricing/calculator.ts): `backend/src/modules/pricing/calculator.ts`
- [Fleet Operations](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/fleet/finesService.ts): `backend/src/modules/fleet/finesService.ts`
- [Rental Lifecycle](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/rentals/routes.ts): `backend/src/modules/rentals/routes.ts`
- [Customer Profiles](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/customers/service.ts): `backend/src/modules/customers/service.ts`

### Security and Platform

- [Authentication](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/authenticate.ts): `backend/src/middleware/authenticate.ts`
- [Role Authorization](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/authorize.ts): `backend/src/middleware/authorize.ts`
- [Request Validation](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/validate.ts): `backend/src/middleware/validate.ts`
- [Audit Trail](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/audit/service.ts): `backend/src/modules/audit/service.ts`
- [Runtime Config](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/env.ts): `backend/src/config/env.ts`
- [Logging](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/logger.ts): `backend/src/config/logger.ts`
- [PostgreSQL Data](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/config/prisma.ts): `backend/src/config/prisma.ts`
- [API Responses](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/apiResponse.ts): `backend/src/utils/apiResponse.ts`
- [Async Route Handling](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/asyncHandler.ts): `backend/src/utils/asyncHandler.ts`
- [Private File Uploads](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/middleware/upload.ts): `backend/src/middleware/upload.ts`
- [Error Model](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/utils/ApiError.ts): `backend/src/utils/ApiError.ts`

### Finance and Outputs

- [Payments and Deposits](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/payments/service.ts): `backend/src/modules/payments/service.ts`
- [Business Settings](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/settings/service.ts): `backend/src/modules/settings/service.ts`
- [Documents and Reports](https://github.com/mohamedsafin/rental-car/blob/main/backend/src/modules/invoices/service.ts): `backend/src/modules/invoices/service.ts`

### Other components

- **Renter**
- **Staff**

## Connections

- Renter → Customer Pages: uses (evidence: `README.md`)
- Customer Pages → Customer API Client: requests through
- Customer API Client → API Application: calls API (evidence: `README.md`)
- Staff → Admin Pages: uses (evidence: `README.md`)
- Admin Pages → Admin API Client: requests through
- Admin API Client → Admin API Types: uses types (evidence: `admin/src/services/api.ts`)
- Admin API Client → API Application: calls API (evidence: `README.md`)
- API Application → Authentication: guards requests (evidence: `README.md`)
- API Application → Role Authorization: guards requests (evidence: `README.md`)
- Booking Lifecycle → Vehicle Availability: checks availability (evidence: `README.md`)
- Booking Lifecycle → Pricing Engine: computes price (evidence: `README.md`)
- Booking Lifecycle → PostgreSQL Data: persists bookings (evidence: `README.md`)
- Fleet Operations → PostgreSQL Data: reads and writes
- Rental Lifecycle → PostgreSQL Data: reads and writes (evidence: `backend/src/modules/rentals/routes.ts`)
- Rental Lifecycle → Booking Lifecycle: updates lifecycle (evidence: `README.md`)
- Customer Profiles → PostgreSQL Data: reads and writes (evidence: `README.md`)
- Payments and Deposits → PostgreSQL Data: records payments (evidence: `backend/src/modules/payments/routes.ts`)
- Payments and Deposits → Booking Lifecycle: confirms booking (evidence: `README.md`)
- Pricing Engine → Business Settings: uses settings
- Documents and Reports → PostgreSQL Data: reads records (evidence: `README.md`)
- API Application → Request Validation: validates inputs (evidence: `README.md`)
- API Application → API Responses: formats responses (evidence: `README.md`)
- API Application → Async Route Handling: wraps handlers (evidence: `README.md`)
- API Application → Error Model: handles failures (evidence: `README.md`)
- Audit Trail → PostgreSQL Data: writes audit log (evidence: `backend/src/modules/audit/service.ts`)
- Audit Trail → Logging: logs failures (evidence: `backend/src/modules/audit/service.ts`)
- PostgreSQL Data → Runtime Config: gets connection config (evidence: `backend/src/config/prisma.ts`)
- PostgreSQL Data → Logging: logs connection failures (evidence: `backend/src/config/prisma.ts`)
- API Application → Private File Uploads: accepts files (evidence: `README.md`)
