# saadshahz/fyp architecture

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

- Interactive diagram: https://gitdiagram.com/saadshahz/fyp
- Repository: https://github.com/saadshahz/fyp

## Overview

This is a role-based maintenance-services marketplace/ERP for consumers, service providers, and administrators. The intended consumer flow covers equipment and inventory management, service requests, provider quotes, contracts, and invoices; providers manage requests, clients, and billing, while administrators oversee users, reports, and support. Sampled imports confirm the dashboard shell, authentication, chatbot, and selected page-to-component links. Many domain pages are present in the tree but were not sampled, so their internal connections are not inferred.

Main entry points: [`src/layouts/DashboardLayout.jsx`](https://github.com/saadshahz/fyp/blob/main/src/layouts/DashboardLayout.jsx) (Dashboard shell), [`src/hooks/useAuth.js`](https://github.com/saadshahz/fyp/blob/main/src/hooks/useAuth.js) (Authentication), [`src/pages/consumer/dashboard.js`](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/dashboard.js) (Consumer dashboard), [`src/pages/consumer/inventory/index.js`](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/inventory/index.js) (Inventory management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_shell["Application Shell"]
  node_auth["Authentication<br/>[useAuth.js]"]
  node_dashboard["Dashboard shell"]
  node_navigation["Navigation<br/>[Sidebar.jsx]"]
  node_navbar["User navigation<br/>[Navbar.jsx]"]
  node_chatbot["Help chatbot<br/>[ChatbotWidget.jsx]"]
  node_ui["Shared UI components"]
  node_src_data_users["User data<br/>[users.js]"]
end

subgraph group_consumer["Consumer Services"]
  node_consumer_dashboard["Consumer dashboard<br/>[dashboard.js]"]
  node_inventory["Inventory management<br/>[index.js]"]
  node_inventory_modals["Inventory forms"]
  node_marketplace["Service marketplace<br/>[marketplace.js]"]
  node_service_requests["Service requests<br/>[index.js]"]
  node_request_detail["Request details<br/>[&#91;id&#93;.js]"]
  node_contracts["Contracts<br/>[contracts.js]"]
  node_invoices["Consumer invoices<br/>[invoices.js]"]
  node_consumer_reports["Consumer reports<br/>[reports.js]"]
end

subgraph group_provider["Provider Operations"]
  node_provider_requests["Provider requests<br/>[index.js]"]
  node_provider_request_detail["Request fulfillment<br/>[&#91;id&#93;.js]"]
  node_clients["Client management<br/>[clients.js]"]
  node_client_detail["Client details"]
  node_provider_invoices["Invoice generation"]
end

subgraph group_admin["Administration"]
  node_admin_dashboard["Admin dashboard<br/>[dashboard.js]"]
  node_admin_users["User administration<br/>[providers.js]"]
  node_support["Support tickets<br/>[support-tickets.js]"]
  node_reports_data["Report data<br/>[reports.js]"]
end

node_user(("Platform user"))

node_user -->|"signs in"| node_auth
node_auth -->|"guards access"| node_dashboard
node_auth -->|"checks accounts"| node_src_data_users
node_dashboard -->|"renders"| node_navigation
node_dashboard -->|"renders"| node_navbar
node_dashboard -->|"renders"| node_chatbot
node_user -.->|"uses"| node_consumer_dashboard
node_consumer_dashboard -->|"renders in"| node_dashboard
node_consumer_dashboard -.->|"links to"| node_inventory
node_inventory -->|"renders in"| node_dashboard
node_inventory -->|"uses forms"| node_inventory_modals
node_user -.->|"requests services"| node_marketplace
node_user -.->|"tracks requests"| node_service_requests
node_service_requests -.->|"opens details"| node_request_detail
node_user -.->|"reviews contracts"| node_contracts
node_user -.->|"reviews invoices"| node_invoices
node_user -.->|"views reports"| node_consumer_reports
node_user -.->|"manages requests"| node_provider_requests
node_provider_requests -.->|"opens details"| node_provider_request_detail
node_clients -->|"renders in"| node_dashboard
node_clients -->|"opens details"| node_client_detail
node_user -.->|"creates invoices"| node_provider_invoices
node_user -.->|"oversees platform"| node_admin_dashboard
node_user -.->|"manages providers"| node_admin_users
node_user -.->|"handles tickets"| node_support
node_admin_dashboard -.->|"uses reports"| node_reports_data

click node_auth "https://github.com/saadshahz/fyp/blob/main/src/hooks/useAuth.js"
click node_dashboard "https://github.com/saadshahz/fyp/blob/main/src/layouts/DashboardLayout.jsx"
click node_navigation "https://github.com/saadshahz/fyp/blob/main/src/components/Sidebar.jsx"
click node_navbar "https://github.com/saadshahz/fyp/blob/main/src/components/Navbar.jsx"
click node_chatbot "https://github.com/saadshahz/fyp/blob/main/src/chatbot/ChatbotWidget.jsx"
click node_ui "https://github.com/saadshahz/fyp/tree/main/src/components/ui"
click node_src_data_users "https://github.com/saadshahz/fyp/blob/main/src/data/users.js"
click node_consumer_dashboard "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/dashboard.js"
click node_inventory "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/inventory/index.js"
click node_inventory_modals "https://github.com/saadshahz/fyp/blob/main/src/components/inventory/InventoryModals.jsx"
click node_marketplace "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/marketplace.js"
click node_service_requests "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/service-requests/index.js"
click node_request_detail "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/service-requests/%5Bid%5D.js"
click node_contracts "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/contracts.js"
click node_invoices "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/invoices.js"
click node_consumer_reports "https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/reports.js"
click node_provider_requests "https://github.com/saadshahz/fyp/blob/main/src/pages/provider/requests/index.js"
click node_provider_request_detail "https://github.com/saadshahz/fyp/blob/main/src/pages/provider/requests/%5Bid%5D.js"
click node_clients "https://github.com/saadshahz/fyp/blob/main/src/pages/provider/clients.js"
click node_client_detail "https://github.com/saadshahz/fyp/blob/main/src/components/clients/ClientDetailModal.jsx"
click node_provider_invoices "https://github.com/saadshahz/fyp/blob/main/src/pages/provider/generate-invoice.js"
click node_admin_dashboard "https://github.com/saadshahz/fyp/blob/main/src/pages/admin/dashboard.js"
click node_admin_users "https://github.com/saadshahz/fyp/blob/main/src/pages/admin/providers.js"
click node_support "https://github.com/saadshahz/fyp/blob/main/src/pages/admin/support-tickets.js"
click node_reports_data "https://github.com/saadshahz/fyp/blob/main/src/data/reports.js"

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_auth,node_dashboard,node_navigation,node_navbar,node_chatbot,node_ui,node_src_data_users,node_user toneBlue
class node_consumer_dashboard,node_inventory,node_inventory_modals,node_marketplace,node_service_requests,node_request_detail,node_contracts,node_invoices,node_consumer_reports toneAmber
class node_provider_requests,node_provider_request_detail,node_clients,node_client_detail,node_provider_invoices toneMint
class node_admin_dashboard,node_admin_users,node_support,node_reports_data toneRose
```

## Components

### Application Shell

- [Authentication](https://github.com/saadshahz/fyp/blob/main/src/hooks/useAuth.js): `src/hooks/useAuth.js`
- [Dashboard shell](https://github.com/saadshahz/fyp/blob/main/src/layouts/DashboardLayout.jsx): `src/layouts/DashboardLayout.jsx`
- [Navigation](https://github.com/saadshahz/fyp/blob/main/src/components/Sidebar.jsx): `src/components/Sidebar.jsx`
- [User navigation](https://github.com/saadshahz/fyp/blob/main/src/components/Navbar.jsx): `src/components/Navbar.jsx`
- [Help chatbot](https://github.com/saadshahz/fyp/blob/main/src/chatbot/ChatbotWidget.jsx): `src/chatbot/ChatbotWidget.jsx`
- [Shared UI components](https://github.com/saadshahz/fyp/tree/main/src/components/ui): `src/components/ui`
- [User data](https://github.com/saadshahz/fyp/blob/main/src/data/users.js): `src/data/users.js`

### Consumer Services

- [Consumer dashboard](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/dashboard.js): `src/pages/consumer/dashboard.js`
- [Inventory management](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/inventory/index.js): `src/pages/consumer/inventory/index.js`
- [Inventory forms](https://github.com/saadshahz/fyp/blob/main/src/components/inventory/InventoryModals.jsx): `src/components/inventory/InventoryModals.jsx`
- [Service marketplace](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/marketplace.js): `src/pages/consumer/marketplace.js`
- [Service requests](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/service-requests/index.js): `src/pages/consumer/service-requests/index.js`
- [Request details](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/service-requests/%5Bid%5D.js): `src/pages/consumer/service-requests/[id].js`
- [Contracts](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/contracts.js): `src/pages/consumer/contracts.js`
- [Consumer invoices](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/invoices.js): `src/pages/consumer/invoices.js`
- [Consumer reports](https://github.com/saadshahz/fyp/blob/main/src/pages/consumer/reports.js): `src/pages/consumer/reports.js`

### Provider Operations

- [Provider requests](https://github.com/saadshahz/fyp/blob/main/src/pages/provider/requests/index.js): `src/pages/provider/requests/index.js`
- [Request fulfillment](https://github.com/saadshahz/fyp/blob/main/src/pages/provider/requests/%5Bid%5D.js): `src/pages/provider/requests/[id].js`
- [Client management](https://github.com/saadshahz/fyp/blob/main/src/pages/provider/clients.js): `src/pages/provider/clients.js`
- [Client details](https://github.com/saadshahz/fyp/blob/main/src/components/clients/ClientDetailModal.jsx): `src/components/clients/ClientDetailModal.jsx`
- [Invoice generation](https://github.com/saadshahz/fyp/blob/main/src/pages/provider/generate-invoice.js): `src/pages/provider/generate-invoice.js`

### Administration

- [Admin dashboard](https://github.com/saadshahz/fyp/blob/main/src/pages/admin/dashboard.js): `src/pages/admin/dashboard.js`
- [User administration](https://github.com/saadshahz/fyp/blob/main/src/pages/admin/providers.js): `src/pages/admin/providers.js`
- [Support tickets](https://github.com/saadshahz/fyp/blob/main/src/pages/admin/support-tickets.js): `src/pages/admin/support-tickets.js`
- [Report data](https://github.com/saadshahz/fyp/blob/main/src/data/reports.js): `src/data/reports.js`

### Other components

- **Platform user**

## Connections

- Platform user → Authentication: signs in (evidence: `src/hooks/useAuth.js`)
- Authentication → Dashboard shell: guards access (evidence: `src/layouts/DashboardLayout.jsx`)
- Authentication → User data: checks accounts (evidence: `src/hooks/useAuth.js`)
- Dashboard shell → Navigation: renders (evidence: `src/layouts/DashboardLayout.jsx`)
- Dashboard shell → User navigation: renders (evidence: `src/layouts/DashboardLayout.jsx`)
- Dashboard shell → Help chatbot: renders (evidence: `src/layouts/DashboardLayout.jsx`)
- Platform user → Consumer dashboard: uses
- Consumer dashboard → Dashboard shell: renders in (evidence: `src/pages/consumer/dashboard.js`)
- Consumer dashboard → Inventory management: links to
- Inventory management → Dashboard shell: renders in (evidence: `src/pages/consumer/inventory/index.js`)
- Inventory management → Inventory forms: uses forms (evidence: `src/pages/consumer/inventory/index.js`)
- Platform user → Service marketplace: requests services
- Platform user → Service requests: tracks requests
- Service requests → Request details: opens details
- Platform user → Contracts: reviews contracts
- Platform user → Consumer invoices: reviews invoices
- Platform user → Consumer reports: views reports
- Platform user → Provider requests: manages requests
- Provider requests → Request fulfillment: opens details
- Client management → Dashboard shell: renders in (evidence: `src/pages/provider/clients.js`)
- Client management → Client details: opens details (evidence: `src/pages/provider/clients.js`)
- Platform user → Invoice generation: creates invoices
- Platform user → Admin dashboard: oversees platform
- Platform user → User administration: manages providers
- Platform user → Support tickets: handles tickets
- Admin dashboard → Report data: uses reports
