# twinemukama/lucys-beauty-parlour-backend architecture

> Architecture diagram of the GitHub repository twinemukama/lucys-beauty-parlour-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/twinemukama/lucys-beauty-parlour-backend
- Repository: https://github.com/twinemukama/lucys-beauty-parlour-backend

## Overview

This is the Go backend for Lucy’s Beauty Parlour web app. Its principal workflow is an HTTP request reaching a Gin handler, which performs appointment or salon-content operations and returns a response; admin operations are gated by JWT middleware. The backend also supports admin login and password recovery, with reset emails sent through Resend. The excerpts establish startup wiring, service-item storage calls, and database setup, but do not show all handler-to-storage or email-provider details, so those relationships are omitted where unsupported.

Main entry points: [`main.go`](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/main.go) (HTTP server), [`handlers/auth.go`](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/auth.go) (Admin auth API), [`middleware/auth.go`](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/middleware/auth.go) (Admin gate), [`handlers/services.go`](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/services.go) (Services API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_http["HTTP and access"]
  node_app["HTTP server<br/>[main.go]"]
  node_authmw["Admin gate<br/>[auth.go]"]
end

subgraph group_salon["Salon operations"]
  node_appointment_api["Appointments API<br/>[appointments.go]"]
  node_services_api["Services API<br/>[services.go]"]
  node_portfolio_api["Portfolio API<br/>[portfolio.go]"]
  node_menu_api["Menu API<br/>[menu_items.go]"]
  node_appointment_model["Appointment data<br/>[appointment.go]"]
  node_service_model["Service data<br/>[service_item.go]"]
  node_portfolio_model["Portfolio data<br/>[portfolio_item.go]"]
  node_menu_model["Menu data<br/>[menu_item.go]"]
  node_image_files["Image handling<br/>[file_storage.go]"]
end

subgraph group_persistence["Persistence"]
  node_store_iface["Store interface<br/>[storage.go]"]
  node_memory_store["Memory store<br/>[storage.go]"]
  node_postgres_store["Postgres store<br/>[postgres.go]"]
  node_db_setup["Database setup<br/>[db.go]"]
  node_db_migrations["Schema and seed<br/>[migrate.go]"]
end

subgraph group_identity["Admin identity"]
  node_admin_api["Admin auth API<br/>[auth.go]"]
  node_tokens["JWT tokens<br/>[tokens.go]"]
  node_refresh_store["Refresh tokens<br/>[storage.go]"]
  node_email["Email service<br/>[email.go]"]
end

node_client(("Web client"))
node_postgres[("PostgreSQL")]
node_resend["Resend"]

node_client -->|"sends requests"| node_app
node_app -->|"routes appointments"| node_appointment_api
node_app -->|"routes services"| node_services_api
node_app -->|"routes portfolio"| node_portfolio_api
node_app -->|"routes menu"| node_menu_api
node_app -->|"routes admin auth"| node_admin_api
node_app -->|"protects admin routes"| node_authmw
node_authmw -->|"verifies token"| node_tokens
node_services_api -->|"reads and writes"| node_store_iface
node_store_iface -.->|"implemented by"| node_memory_store
node_app -->|"constructs store"| node_postgres_store
node_postgres_store -->|"queries"| node_postgres
node_app -->|"opens database"| node_db_setup
node_app -->|"migrates and seeds"| node_db_migrations
node_db_setup -->|"connects"| node_postgres
node_db_migrations -->|"creates schema"| node_postgres
node_admin_api -->|"checks credentials"| node_postgres
node_admin_api -->|"creates and verifies"| node_tokens
node_admin_api -->|"stores refresh tokens"| node_refresh_store
node_admin_api -->|"sends account email"| node_email
node_email -->|"sends messages"| node_resend

click node_app "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/main.go"
click node_authmw "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/middleware/auth.go"
click node_appointment_api "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/appointments.go"
click node_services_api "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/services.go"
click node_portfolio_api "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/portfolio.go"
click node_menu_api "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/menu_items.go"
click node_appointment_model "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/appointment.go"
click node_service_model "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/service_item.go"
click node_portfolio_model "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/portfolio_item.go"
click node_menu_model "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/menu_item.go"
click node_image_files "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/file_storage.go"
click node_store_iface "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go"
click node_memory_store "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go"
click node_postgres_store "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/postgres.go"
click node_db_setup "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/database/db.go"
click node_db_migrations "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/database/migrate.go"
click node_admin_api "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/auth.go"
click node_tokens "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/tokens.go"
click node_refresh_store "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go"
click node_email "https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/email.go"

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_authmw,node_client toneBlue
class node_appointment_api,node_services_api,node_portfolio_api,node_menu_api,node_appointment_model,node_service_model,node_portfolio_model,node_menu_model,node_image_files,node_postgres toneAmber
class node_store_iface,node_memory_store,node_postgres_store,node_db_setup,node_db_migrations toneMint
class node_admin_api,node_tokens,node_refresh_store,node_email toneRose
class node_resend toneIndigo
```

## Components

### HTTP and access

- [HTTP server](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/main.go): `main.go`
- [Admin gate](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/middleware/auth.go): `middleware/auth.go`

### Salon operations

- [Appointments API](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/appointments.go): `handlers/appointments.go`
- [Services API](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/services.go): `handlers/services.go`
- [Portfolio API](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/portfolio.go): `handlers/portfolio.go`
- [Menu API](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/menu_items.go): `handlers/menu_items.go`
- [Appointment data](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/appointment.go): `models/appointment.go`
- [Service data](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/service_item.go): `models/service_item.go`
- [Portfolio data](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/portfolio_item.go): `models/portfolio_item.go`
- [Menu data](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/models/menu_item.go): `models/menu_item.go`
- [Image handling](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/file_storage.go): `utils/file_storage.go`

### Persistence

- [Store interface](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go): `storage/storage.go`
- [Memory store](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go): `storage/storage.go`
- [Postgres store](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/postgres.go): `storage/postgres.go`
- [Database setup](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/database/db.go): `database/db.go`
- [Schema and seed](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/database/migrate.go): `database/migrate.go`

### Admin identity

- [Admin auth API](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/handlers/auth.go): `handlers/auth.go`
- [JWT tokens](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/tokens.go): `utils/tokens.go`
- [Refresh tokens](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/storage/storage.go): `storage/storage.go`
- [Email service](https://github.com/twinemukama/lucys-beauty-parlour-backend/blob/main/utils/email.go): `utils/email.go`

### Other components

- **Web client**
- **PostgreSQL**
- **Resend**

## Connections

- Web client → HTTP server: sends requests (evidence: `main.go`)
- HTTP server → Appointments API: routes appointments (evidence: `main.go`)
- HTTP server → Services API: routes services (evidence: `main.go`)
- HTTP server → Portfolio API: routes portfolio (evidence: `main.go`)
- HTTP server → Menu API: routes menu (evidence: `main.go`)
- HTTP server → Admin auth API: routes admin auth (evidence: `main.go`)
- HTTP server → Admin gate: protects admin routes (evidence: `main.go`)
- Admin gate → JWT tokens: verifies token (evidence: `middleware/auth.go`)
- Services API → Store interface: reads and writes (evidence: `handlers/services.go`)
- Store interface → Memory store: implemented by (evidence: `storage/storage.go`)
- HTTP server → Postgres store: constructs store (evidence: `main.go`)
- Postgres store → PostgreSQL: queries (evidence: `storage/postgres.go`)
- HTTP server → Database setup: opens database (evidence: `main.go`)
- HTTP server → Schema and seed: migrates and seeds (evidence: `main.go`)
- Database setup → PostgreSQL: connects (evidence: `database/db.go`)
- Schema and seed → PostgreSQL: creates schema (evidence: `database/migrate.go`)
- Admin auth API → PostgreSQL: checks credentials (evidence: `handlers/auth.go`)
- Admin auth API → JWT tokens: creates and verifies (evidence: `handlers/auth.go`)
- Admin auth API → Refresh tokens: stores refresh tokens (evidence: `handlers/auth.go`)
- Admin auth API → Email service: sends account email (evidence: `handlers/auth.go`)
- Email service → Resend: sends messages (evidence: `utils/email.go`)
