# facolydev/gazup architecture

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

- Interactive diagram: https://gitdiagram.com/facolydev/gazup
- Repository: https://github.com/facolydev/gazup

## Overview

GazUp is a multi-store gas-delivery platform: customers browse a store’s catalog, place and track an order, and receive delivery; stores manage orders and couriers, while platform supervisors administer stores, service fees, and settlements. Four Flutter apps and the public website use a PHP API, with store and supervisor back offices alongside it. The README documents the wider product capabilities; sampled source confirms several shared runtime layers, but not every endpoint-to-domain call, so those links are shown only where documented.

Main entry points: [`backend/includes/api.php`](https://github.com/facolydev/gazup/blob/main/backend/includes/api.php) (API runtime), [`backend/includes/metier.php`](https://github.com/facolydev/gazup/blob/main/backend/includes/metier.php) (Business rules), [`backend/includes/web.php`](https://github.com/facolydev/gazup/blob/main/backend/includes/web.php) (Back-office runtime), [`backend/includes/fonctions.php`](https://github.com/facolydev/gazup/blob/main/backend/includes/fonctions.php) (Shared functions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_channels["Customer and mobile channels"]
  node_client_app["Client app"]
  node_courier_app["Courier app"]
  node_store_app["Store app"]
  node_supervisor_app["Supervisor app"]
  node_public_shop["Public shop<br/>[index.php]"]
end

subgraph group_operations["Store operations"]
  node_store_admin["Store back office"]
  node_catalog["Catalog management"]
  node_orders["Order lifecycle"]
  node_courier_ops["Courier operations"]
  node_dispatch["Courier dispatch"]
end

subgraph group_platform["Platform administration"]
  node_superadmin["Platform back office"]
  node_store_directory["Store management"]
  node_fees_settlements["Fees and settlements<br/>[commission.php]"]
end

subgraph group_backend["API and domain services"]
  node_customer_accounts["Customer accounts"]
  node_authentication["Authentication<br/>[auth.php]"]
  node_api_runtime["API runtime<br/>[api.php]"]
  node_business_rules["Business rules<br/>[metier.php]"]
  node_notifications["Notifications<br/>[notifications.php]"]
  node_payments["Payments"]
  node_places["Delivery locations"]
  node_analytics["Statistics and charts<br/>[stats.php]"]
  node_web_runtime["Back-office runtime<br/>[web.php]"]
  node_site_runtime["Site rendering<br/>[site.php]"]
  node_shared_functions["Shared functions<br/>[fonctions.php]"]
  node_accounts["Account balances<br/>[comptes.php]"]
end

subgraph group_infrastructure["Persistence and integrations"]
  node_config["Configuration<br/>[config.php]"]
  node_database_access["Database access<br/>[db.php]"]
  node_database[("MySQL database")]
  node_schema_migrations["Schema migration<br/>[migrer.php]"]
  node_mobile_money["Mobile money provider"]
  node_maps["Maps and routing"]
  node_push_service["Push service"]
  node_cinetpay["CinetPay integration<br/>[cinetpay.php]"]
end

node_customer(("Customer"))

node_customer -->|"browses"| node_public_shop
node_customer -.->|"uses"| node_client_app
node_client_app -.->|"calls API"| node_api_runtime
node_courier_app -.->|"calls API"| node_api_runtime
node_store_app -.->|"calls API"| node_api_runtime
node_supervisor_app -.->|"calls API"| node_api_runtime
node_public_shop -->|"renders via"| node_site_runtime
node_store_admin -->|"uses"| node_web_runtime
node_superadmin -->|"uses"| node_web_runtime
node_store_admin -->|"reads stats"| node_analytics
node_superadmin -->|"reads stats"| node_analytics
node_api_runtime -->|"loads"| node_authentication
node_api_runtime -->|"loads"| node_business_rules
node_api_runtime -->|"expires orders"| node_business_rules
node_api_runtime -->|"queues pushes"| node_notifications
node_authentication -->|"uses"| node_shared_functions
node_business_rules -->|"uses"| node_shared_functions
node_business_rules -->|"sends notices"| node_notifications
node_business_rules -->|"updates balances"| node_accounts
node_business_rules -->|"uses fee rules"| node_fees_settlements
node_orders -.->|"applies rules"| node_business_rules
node_dispatch -.->|"uses dispatch rules"| node_business_rules
node_store_directory -.->|"serves endpoints"| node_api_runtime
node_catalog -.->|"serves endpoints"| node_api_runtime
node_customer_accounts -.->|"serves endpoints"| node_api_runtime
node_orders -.->|"serves endpoints"| node_api_runtime
node_courier_ops -.->|"serves endpoints"| node_api_runtime
node_dispatch -.->|"serves endpoints"| node_api_runtime
node_payments -.->|"serves endpoints"| node_api_runtime
node_places -.->|"serves endpoints"| node_api_runtime
node_payments -->|"uses"| node_cinetpay
node_cinetpay -.->|"integrates"| node_mobile_money
node_places -.->|"queries"| node_maps
node_notifications -.->|"pushes optionally"| node_push_service
node_shared_functions -->|"uses"| node_database_access
node_database_access -->|"loads settings"| node_config
node_database_access -.->|"queries"| node_database
node_schema_migrations -->|"uses"| node_database_access
node_accounts -->|"uses"| node_shared_functions
node_fees_settlements -->|"uses"| node_shared_functions
node_web_runtime -->|"uses"| node_authentication
node_web_runtime -->|"uses"| node_business_rules
node_web_runtime -->|"loads stats"| node_analytics
node_site_runtime -->|"uses"| node_web_runtime

click node_client_app "https://github.com/facolydev/gazup/tree/main/mobile/app_client"
click node_courier_app "https://github.com/facolydev/gazup/tree/main/mobile/app_livreur"
click node_store_app "https://github.com/facolydev/gazup/tree/main/mobile/app_magasin"
click node_supervisor_app "https://github.com/facolydev/gazup/tree/main/mobile/app_superviseur"
click node_public_shop "https://github.com/facolydev/gazup/blob/main/backend/index.php"
click node_store_admin "https://github.com/facolydev/gazup/tree/main/backend/admin"
click node_catalog "https://github.com/facolydev/gazup/tree/main/backend/api/produits"
click node_orders "https://github.com/facolydev/gazup/tree/main/backend/api/commandes"
click node_courier_ops "https://github.com/facolydev/gazup/tree/main/backend/api/livreurs"
click node_dispatch "https://github.com/facolydev/gazup/tree/main/backend/api/attribution"
click node_superadmin "https://github.com/facolydev/gazup/tree/main/backend/superadmin"
click node_store_directory "https://github.com/facolydev/gazup/tree/main/backend/api/magasins"
click node_fees_settlements "https://github.com/facolydev/gazup/blob/main/backend/includes/commission.php"
click node_customer_accounts "https://github.com/facolydev/gazup/tree/main/backend/api/clients"
click node_authentication "https://github.com/facolydev/gazup/blob/main/backend/includes/auth.php"
click node_api_runtime "https://github.com/facolydev/gazup/blob/main/backend/includes/api.php"
click node_business_rules "https://github.com/facolydev/gazup/blob/main/backend/includes/metier.php"
click node_notifications "https://github.com/facolydev/gazup/blob/main/backend/includes/notifications.php"
click node_payments "https://github.com/facolydev/gazup/tree/main/backend/api/paiements"
click node_places "https://github.com/facolydev/gazup/tree/main/backend/api/lieux"
click node_analytics "https://github.com/facolydev/gazup/blob/main/backend/includes/stats.php"
click node_web_runtime "https://github.com/facolydev/gazup/blob/main/backend/includes/web.php"
click node_site_runtime "https://github.com/facolydev/gazup/blob/main/backend/includes/site.php"
click node_shared_functions "https://github.com/facolydev/gazup/blob/main/backend/includes/fonctions.php"
click node_config "https://github.com/facolydev/gazup/blob/main/backend/config/config.php"
click node_database_access "https://github.com/facolydev/gazup/blob/main/backend/includes/db.php"
click node_schema_migrations "https://github.com/facolydev/gazup/blob/main/backend/database/migrer.php"
click node_cinetpay "https://github.com/facolydev/gazup/blob/main/backend/includes/cinetpay.php"
click node_accounts "https://github.com/facolydev/gazup/blob/main/backend/includes/comptes.php"

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_client_app,node_courier_app,node_store_app,node_supervisor_app,node_public_shop toneBlue
class node_store_admin,node_catalog,node_orders,node_courier_ops,node_dispatch toneAmber
class node_superadmin,node_store_directory,node_fees_settlements toneMint
class node_customer_accounts,node_authentication,node_api_runtime,node_business_rules,node_notifications,node_payments,node_places,node_analytics,node_web_runtime,node_site_runtime,node_shared_functions,node_accounts toneRose
class node_config,node_database_access,node_database,node_schema_migrations,node_mobile_money,node_maps,node_push_service,node_cinetpay,node_customer toneIndigo
```

## Components

### Customer and mobile channels

- [Client app](https://github.com/facolydev/gazup/tree/main/mobile/app_client): `mobile/app_client`
- [Courier app](https://github.com/facolydev/gazup/tree/main/mobile/app_livreur): `mobile/app_livreur`
- [Store app](https://github.com/facolydev/gazup/tree/main/mobile/app_magasin): `mobile/app_magasin`
- [Supervisor app](https://github.com/facolydev/gazup/tree/main/mobile/app_superviseur): `mobile/app_superviseur`
- [Public shop](https://github.com/facolydev/gazup/blob/main/backend/index.php): `backend/index.php`

### Store operations

- [Store back office](https://github.com/facolydev/gazup/tree/main/backend/admin): `backend/admin`
- [Catalog management](https://github.com/facolydev/gazup/tree/main/backend/api/produits): `backend/api/produits`
- [Order lifecycle](https://github.com/facolydev/gazup/tree/main/backend/api/commandes): `backend/api/commandes`
- [Courier operations](https://github.com/facolydev/gazup/tree/main/backend/api/livreurs): `backend/api/livreurs`
- [Courier dispatch](https://github.com/facolydev/gazup/tree/main/backend/api/attribution): `backend/api/attribution`

### Platform administration

- [Platform back office](https://github.com/facolydev/gazup/tree/main/backend/superadmin): `backend/superadmin`
- [Store management](https://github.com/facolydev/gazup/tree/main/backend/api/magasins): `backend/api/magasins`
- [Fees and settlements](https://github.com/facolydev/gazup/blob/main/backend/includes/commission.php): `backend/includes/commission.php`

### API and domain services

- [Customer accounts](https://github.com/facolydev/gazup/tree/main/backend/api/clients): `backend/api/clients`
- [Authentication](https://github.com/facolydev/gazup/blob/main/backend/includes/auth.php): `backend/includes/auth.php`
- [API runtime](https://github.com/facolydev/gazup/blob/main/backend/includes/api.php): `backend/includes/api.php`
- [Business rules](https://github.com/facolydev/gazup/blob/main/backend/includes/metier.php): `backend/includes/metier.php`
- [Notifications](https://github.com/facolydev/gazup/blob/main/backend/includes/notifications.php): `backend/includes/notifications.php`
- [Payments](https://github.com/facolydev/gazup/tree/main/backend/api/paiements): `backend/api/paiements`
- [Delivery locations](https://github.com/facolydev/gazup/tree/main/backend/api/lieux): `backend/api/lieux`
- [Statistics and charts](https://github.com/facolydev/gazup/blob/main/backend/includes/stats.php): `backend/includes/stats.php`
- [Back-office runtime](https://github.com/facolydev/gazup/blob/main/backend/includes/web.php): `backend/includes/web.php`
- [Site rendering](https://github.com/facolydev/gazup/blob/main/backend/includes/site.php): `backend/includes/site.php`
- [Shared functions](https://github.com/facolydev/gazup/blob/main/backend/includes/fonctions.php): `backend/includes/fonctions.php`
- [Account balances](https://github.com/facolydev/gazup/blob/main/backend/includes/comptes.php): `backend/includes/comptes.php`

### Persistence and integrations

- [Configuration](https://github.com/facolydev/gazup/blob/main/backend/config/config.php): `backend/config/config.php`
- [Database access](https://github.com/facolydev/gazup/blob/main/backend/includes/db.php): `backend/includes/db.php`
- **MySQL database**
- [Schema migration](https://github.com/facolydev/gazup/blob/main/backend/database/migrer.php): `backend/database/migrer.php`
- **Mobile money provider**
- **Maps and routing**
- **Push service**
- [CinetPay integration](https://github.com/facolydev/gazup/blob/main/backend/includes/cinetpay.php): `backend/includes/cinetpay.php`

### Other components

- **Customer**

## Connections

- Customer → Public shop: browses (evidence: `backend/index.php`)
- Customer → Client app: uses (evidence: `README.md`)
- Client app → API runtime: calls API (evidence: `README.md`)
- Courier app → API runtime: calls API (evidence: `README.md`)
- Store app → API runtime: calls API (evidence: `README.md`)
- Supervisor app → API runtime: calls API (evidence: `README.md`)
- Public shop → Site rendering: renders via (evidence: `backend/index.php`)
- Store back office → Back-office runtime: uses (evidence: `backend/admin/index.php`)
- Platform back office → Back-office runtime: uses (evidence: `backend/superadmin/index.php`)
- Store back office → Statistics and charts: reads stats (evidence: `backend/admin/index.php`)
- Platform back office → Statistics and charts: reads stats (evidence: `backend/superadmin/index.php`)
- API runtime → Authentication: loads (evidence: `backend/includes/api.php`)
- API runtime → Business rules: loads (evidence: `backend/includes/api.php`)
- API runtime → Business rules: expires orders (evidence: `backend/includes/api.php`)
- API runtime → Notifications: queues pushes (evidence: `backend/includes/api.php`)
- Authentication → Shared functions: uses (evidence: `backend/includes/auth.php`)
- Business rules → Shared functions: uses (evidence: `backend/includes/metier.php`)
- Business rules → Notifications: sends notices (evidence: `backend/includes/metier.php`)
- Business rules → Account balances: updates balances (evidence: `backend/includes/metier.php`)
- Business rules → Fees and settlements: uses fee rules (evidence: `backend/includes/metier.php`)
- Order lifecycle → Business rules: applies rules (evidence: `README.md`)
- Courier dispatch → Business rules: uses dispatch rules (evidence: `README.md`)
- Store management → API runtime: serves endpoints (evidence: `README.md`)
- Catalog management → API runtime: serves endpoints (evidence: `README.md`)
- Customer accounts → API runtime: serves endpoints (evidence: `README.md`)
- Order lifecycle → API runtime: serves endpoints (evidence: `README.md`)
- Courier operations → API runtime: serves endpoints (evidence: `README.md`)
- Courier dispatch → API runtime: serves endpoints (evidence: `README.md`)
- Payments → API runtime: serves endpoints (evidence: `README.md`)
- Delivery locations → API runtime: serves endpoints (evidence: `README.md`)
- Payments → CinetPay integration: uses (evidence: `backend/api/paiements/initier.php`)
- CinetPay integration → Mobile money provider: integrates
- Delivery locations → Maps and routing: queries (evidence: `README.md`)
- Notifications → Push service: pushes optionally
- Shared functions → Database access: uses (evidence: `backend/includes/fonctions.php`)
- Database access → Configuration: loads settings (evidence: `backend/includes/db.php`)
- Database access → MySQL database: queries (evidence: `README.md`)
- Schema migration → Database access: uses (evidence: `backend/database/migrer.php`)
- Account balances → Shared functions: uses (evidence: `backend/includes/comptes.php`)
- Fees and settlements → Shared functions: uses (evidence: `backend/includes/commission.php`)
- Back-office runtime → Authentication: uses (evidence: `backend/includes/web.php`)
- Back-office runtime → Business rules: uses (evidence: `backend/includes/web.php`)
- Back-office runtime → Statistics and charts: loads stats (evidence: `backend/includes/web.php`)
- Site rendering → Back-office runtime: uses (evidence: `backend/includes/site.php`)
