# nichom01/delivery architecture

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

- Interactive diagram: https://gitdiagram.com/nichom01/delivery
- Repository: https://github.com/nichom01/delivery

## Overview

This is a full-stack, multi-depot delivery operations platform. Depot staff and administrators use the React UI to manage orders, routing, goods receiving, manifests, and operational dashboards; external systems can also submit orders through the API. The Spring API applies business logic and persists operational data. README-documented flows establish the UI/API and database boundaries; source excerpts confirm selected manifest, order-routing, and dashboard behavior. Several subsystem links use directory-level nodes because their individual source was not sampled.

Main entry points: [`delivery-api/src/main/java/com/deliverysystem/controller/api/v1`](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/controller/api/v1) (REST endpoints), [`delivery-api/src/main/java/com/deliverysystem/repository`](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/repository) (Data access), [`delivery-api/src/main/java/com/deliverysystem/service/OrderService.java`](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/OrderService.java) (Order management), [`delivery-ui/src/api/apiClient.ts`](https://github.com/nichom01/delivery/blob/main/delivery-ui/src/api/apiClient.ts) (HTTP client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Operations UI"]
  node_pages["Operations pages"]
  node_clientservices["API services"]
  node_apiclient["HTTP client<br/>[apiClient.ts]"]
end

subgraph group_api["Delivery API"]
  node_authcontroller["Authentication"]
  node_controllers["REST endpoints"]
  node_manifestcontroller["Manifest endpoint"]
end

subgraph group_ops["Operations workflows"]
  node_orders["Order management<br/>[OrderService.java]"]
  node_routing["Postcode routing"]
  node_manifests["Manifest workflow"]
  node_dashboard["Dashboard metrics"]
  node_routes["Route operations<br/>[RouteService.java]"]
  node_audit["Audit logging<br/>[AuditService.java]"]
end

subgraph group_data["Persistence and security"]
  node_repositories["Data access"]
  node_entities["Operational records"]
  node_security["Authentication controls"]
end

node_staff(("Depot staff"))
node_external(("Order systems"))
node_postgres[("PostgreSQL")]

node_staff -->|"uses"| node_pages
node_pages -.->|"requests data"| node_clientservices
node_clientservices -->|"calls"| node_apiclient
node_apiclient -->|"sends REST requests"| node_controllers
node_external -->|"submits orders"| node_controllers
node_controllers -.->|"delegates"| node_orders
node_controllers -.->|"requests metrics"| node_dashboard
node_controllers -.->|"requests route data"| node_routes
node_manifestcontroller -->|"delegates"| node_manifests
node_orders -->|"resolves postcode"| node_routing
node_orders -->|"records changes"| node_audit
node_manifests -->|"records changes"| node_audit
node_routes -.->|"records changes"| node_audit
node_dashboard -->|"reads metrics data"| node_repositories
node_routes -->|"reads route data"| node_repositories
node_manifests -->|"reads and writes"| node_repositories
node_orders -->|"reads and writes"| node_repositories
node_repositories -.->|"persists records"| node_entities
node_entities -->|"stored in"| node_postgres
node_authcontroller -->|"issues tokens"| node_security
node_apiclient -->|"sends JWT"| node_security

click node_pages "https://github.com/nichom01/delivery/tree/main/delivery-ui/src/pages"
click node_clientservices "https://github.com/nichom01/delivery/tree/main/delivery-ui/src/api/services"
click node_apiclient "https://github.com/nichom01/delivery/blob/main/delivery-ui/src/api/apiClient.ts"
click node_authcontroller "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/controller/auth/AuthController.java"
click node_controllers "https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/controller/api/v1"
click node_manifestcontroller "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/controller/api/v1/ManifestController.java"
click node_orders "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/OrderService.java"
click node_routing "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/PostcodeRoutingService.java"
click node_manifests "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/ManifestService.java"
click node_dashboard "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/DashboardService.java"
click node_routes "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/RouteService.java"
click node_audit "https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/AuditService.java"
click node_repositories "https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/repository"
click node_entities "https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/domain"
click node_security "https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/security"

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_pages,node_clientservices,node_apiclient toneBlue
class node_authcontroller,node_controllers,node_manifestcontroller,node_postgres toneAmber
class node_orders,node_routing,node_manifests,node_dashboard,node_routes,node_audit toneMint
class node_repositories,node_entities,node_security toneRose
class node_staff,node_external toneIndigo
```

## Components

### Operations UI

- [Operations pages](https://github.com/nichom01/delivery/tree/main/delivery-ui/src/pages): `delivery-ui/src/pages`
- [API services](https://github.com/nichom01/delivery/tree/main/delivery-ui/src/api/services): `delivery-ui/src/api/services`
- [HTTP client](https://github.com/nichom01/delivery/blob/main/delivery-ui/src/api/apiClient.ts): `delivery-ui/src/api/apiClient.ts`

### Delivery API

- [Authentication](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/controller/auth/AuthController.java): `delivery-api/src/main/java/com/deliverysystem/controller/auth/AuthController.java`
- [REST endpoints](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/controller/api/v1): `delivery-api/src/main/java/com/deliverysystem/controller/api/v1`
- [Manifest endpoint](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/controller/api/v1/ManifestController.java): `delivery-api/src/main/java/com/deliverysystem/controller/api/v1/ManifestController.java`

### Operations workflows

- [Order management](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/OrderService.java): `delivery-api/src/main/java/com/deliverysystem/service/OrderService.java`
- [Postcode routing](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/PostcodeRoutingService.java): `delivery-api/src/main/java/com/deliverysystem/service/PostcodeRoutingService.java`
- [Manifest workflow](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/ManifestService.java): `delivery-api/src/main/java/com/deliverysystem/service/ManifestService.java`
- [Dashboard metrics](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/DashboardService.java): `delivery-api/src/main/java/com/deliverysystem/service/DashboardService.java`
- [Route operations](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/RouteService.java): `delivery-api/src/main/java/com/deliverysystem/service/RouteService.java`
- [Audit logging](https://github.com/nichom01/delivery/blob/main/delivery-api/src/main/java/com/deliverysystem/service/AuditService.java): `delivery-api/src/main/java/com/deliverysystem/service/AuditService.java`

### Persistence and security

- [Data access](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/repository): `delivery-api/src/main/java/com/deliverysystem/repository`
- [Operational records](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/domain): `delivery-api/src/main/java/com/deliverysystem/domain`
- [Authentication controls](https://github.com/nichom01/delivery/tree/main/delivery-api/src/main/java/com/deliverysystem/security): `delivery-api/src/main/java/com/deliverysystem/security`

### Other components

- **Depot staff**
- **Order systems**
- **PostgreSQL**

## Connections

- Depot staff → Operations pages: uses (evidence: `README.md`)
- Operations pages → API services: requests data
- API services → HTTP client: calls (evidence: `delivery-ui/src/api/services/routeService.ts`)
- HTTP client → REST endpoints: sends REST requests (evidence: `README.md`)
- Order systems → REST endpoints: submits orders (evidence: `README.md`)
- REST endpoints → Order management: delegates
- REST endpoints → Dashboard metrics: requests metrics
- REST endpoints → Route operations: requests route data
- Manifest endpoint → Manifest workflow: delegates (evidence: `delivery-api/src/main/java/com/deliverysystem/controller/api/v1/ManifestController.java`)
- Order management → Postcode routing: resolves postcode (evidence: `delivery-api/src/main/java/com/deliverysystem/service/OrderService.java`)
- Order management → Audit logging: records changes (evidence: `delivery-api/src/main/java/com/deliverysystem/service/OrderService.java`)
- Manifest workflow → Audit logging: records changes (evidence: `delivery-api/src/main/java/com/deliverysystem/service/ManifestService.java`)
- Route operations → Audit logging: records changes (evidence: `delivery-api/src/main/java/com/deliverysystem/service/RouteService.java`)
- Dashboard metrics → Data access: reads metrics data (evidence: `delivery-api/src/main/java/com/deliverysystem/service/DashboardService.java`)
- Route operations → Data access: reads route data (evidence: `delivery-api/src/main/java/com/deliverysystem/service/RouteService.java`)
- Manifest workflow → Data access: reads and writes (evidence: `delivery-api/src/main/java/com/deliverysystem/service/ManifestService.java`)
- Order management → Data access: reads and writes (evidence: `delivery-api/src/main/java/com/deliverysystem/service/OrderService.java`)
- Data access → Operational records: persists records (evidence: `delivery-api/src/main/java/com/deliverysystem/repository/PostcodeRuleRepository.java`)
- Operational records → PostgreSQL: stored in (evidence: `README.md`)
- Authentication → Authentication controls: issues tokens (evidence: `delivery-api/src/main/java/com/deliverysystem/controller/auth/AuthController.java`)
- HTTP client → Authentication controls: sends JWT (evidence: `README.md`)
