# sanidhyatilekar18/shipment_app architecture

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

## Overview

Shipster is a React shipment-tracking app backed by Firebase Authentication and Firestore. Users register or log in, create shipments, view their own shipments, cancel eligible pending shipments, and track by shipment ID. Admins have a dashboard for reviewing, filtering, updating, exporting, and cleaning up shipments. App.jsx owns the visible route dispatch; authentication state and Firebase setup are shared internal layers. AdminLogin.jsx and AdminRoute.jsx exist, but the sampled router does not show them in use. Some feature links below are documented in the README; unsampled implementation details are not inferred.

Main entry points: [`src/App.jsx`](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/App.jsx) (Route application), [`src/config/firebase.js`](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/config/firebase.js) (Firebase setup), [`src/context/AuthContext.jsx`](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/context/AuthContext.jsx) (Auth state), [`src/pages/CreateShipment.jsx`](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/CreateShipment.jsx) (Create shipment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_routing["App and navigation"]
  node_app["Route application<br/>[App.jsx]"]
  node_navbar["Navigation bar<br/>[Navbar.jsx]"]
  node_home["Home page<br/>[Home.jsx]"]
end

subgraph group_identity["Identity and access"]
  node_private["Private route guard<br/>[PrivateRoute.jsx]"]
  node_admin_guard["Admin route guard<br/>[AdminRoute.jsx]"]
  node_auth_context["Auth state<br/>[AuthContext.jsx]"]
  node_login["User login<br/>[Login.jsx]"]
  node_register["Registration<br/>[Register.jsx]"]
  node_admin_login["Admin login<br/>[AdminLogin.jsx]"]
  node_admins["Admin email list<br/>[admins.js]"]
  node_profile["User profile<br/>[UserProfile.jsx]"]
end

subgraph group_shipments["Shipment workflows"]
  node_create["Create shipment<br/>[CreateShipment.jsx]"]
  node_my_shipments["My shipments<br/>[Shipments.jsx]"]
  node_tracking["Shipment tracking<br/>[TrackShipment.jsx]"]
end

subgraph group_admin["Administration"]
  node_admin_dashboard["Shipment dashboard<br/>[AdminDashboard.jsx]"]
end

subgraph group_backend["Firebase services"]
  node_firebase_config["Firebase setup<br/>[firebase.js]"]
  node_firebase_auth["Firebase Auth"]
  node_firestore[("Shipment records")]
end

node_visitor(("Visitor / user"))
node_email_service["EmailJS service"]

node_visitor -->|"opens app"| node_app
node_app -->|"renders"| node_navbar
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_login
node_app -->|"routes to"| node_register
node_app -->|"guards routes"| node_private
node_private -->|"renders when signed in"| node_create
node_private -->|"renders when signed in"| node_my_shipments
node_app -->|"routes to"| node_tracking
node_app -->|"routes when admin"| node_admin_dashboard
node_app -->|"provides auth state"| node_auth_context
node_app -->|"checks admin email"| node_admins
node_navbar -->|"shows profile"| node_profile
node_navbar -->|"checks admin email"| node_admins
node_auth_context -->|"observes auth"| node_firebase_config
node_firebase_config -->|"initializes"| node_firebase_auth
node_firebase_config -->|"initializes"| node_firestore
node_login -->|"uses Firebase"| node_firebase_config
node_register -->|"uses Firebase"| node_firebase_config
node_admin_login -->|"uses Firebase"| node_firebase_config
node_admin_login -->|"checks admin access"| node_admins
node_admin_guard -->|"checks signed-in user"| node_auth_context
node_admin_guard -->|"checks admin access"| node_admins
node_profile -->|"reads user state"| node_auth_context
node_profile -->|"signs out"| node_firebase_config
node_create -->|"reads current user"| node_auth_context
node_create -->|"creates shipment"| node_firestore
node_create -->|"sends OTP"| node_email_service
node_my_shipments -->|"reads current user"| node_auth_context
node_my_shipments -->|"reads and updates shipments"| node_firestore
node_my_shipments -->|"links to track"| node_tracking
node_tracking -->|"uses Firebase"| node_firebase_config
node_admin_dashboard -->|"reads and updates records"| node_firestore

click node_app "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/App.jsx"
click node_navbar "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/Navbar.jsx"
click node_home "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Home.jsx"
click node_private "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/PrivateRoute.jsx"
click node_admin_guard "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/AdminRoute.jsx"
click node_auth_context "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/context/AuthContext.jsx"
click node_login "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Login.jsx"
click node_register "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Register.jsx"
click node_admin_login "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/AdminLogin.jsx"
click node_admins "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/constants/admins.js"
click node_profile "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/UserProfile.jsx"
click node_create "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/CreateShipment.jsx"
click node_my_shipments "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Shipments.jsx"
click node_tracking "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/TrackShipment.jsx"
click node_admin_dashboard "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/AdminDashboard.jsx"
click node_firebase_config "https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/config/firebase.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_app,node_navbar,node_home,node_visitor toneBlue
class node_private,node_admin_guard,node_auth_context,node_login,node_register,node_admin_login,node_admins,node_profile toneAmber
class node_create,node_my_shipments,node_tracking toneMint
class node_admin_dashboard toneRose
class node_firebase_config,node_firebase_auth,node_firestore,node_email_service toneIndigo
```

## Components

### App and navigation

- [Route application](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/App.jsx): `src/App.jsx`
- [Navigation bar](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/Navbar.jsx): `src/components/Navbar.jsx`
- [Home page](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Home.jsx): `src/pages/Home.jsx`

### Identity and access

- [Private route guard](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/PrivateRoute.jsx): `src/components/PrivateRoute.jsx`
- [Admin route guard](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/AdminRoute.jsx): `src/components/AdminRoute.jsx`
- [Auth state](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/context/AuthContext.jsx): `src/context/AuthContext.jsx`
- [User login](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Login.jsx): `src/pages/Login.jsx`
- [Registration](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Register.jsx): `src/pages/Register.jsx`
- [Admin login](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/AdminLogin.jsx): `src/pages/AdminLogin.jsx`
- [Admin email list](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/constants/admins.js): `src/constants/admins.js`
- [User profile](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/components/UserProfile.jsx): `src/components/UserProfile.jsx`

### Shipment workflows

- [Create shipment](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/CreateShipment.jsx): `src/pages/CreateShipment.jsx`
- [My shipments](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/Shipments.jsx): `src/pages/Shipments.jsx`
- [Shipment tracking](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/TrackShipment.jsx): `src/pages/TrackShipment.jsx`

### Administration

- [Shipment dashboard](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/pages/AdminDashboard.jsx): `src/pages/AdminDashboard.jsx`

### Firebase services

- [Firebase setup](https://github.com/sanidhyatilekar18/shipment_app/blob/main/src/config/firebase.js): `src/config/firebase.js`
- **Firebase Auth**
- **Shipment records**

### Other components

- **Visitor / user**
- **EmailJS service**

## Connections

- Visitor / user → Route application: opens app (evidence: `README.md`)
- Route application → Navigation bar: renders (evidence: `src/App.jsx`)
- Route application → Home page: routes to (evidence: `src/App.jsx`)
- Route application → User login: routes to (evidence: `src/App.jsx`)
- Route application → Registration: routes to (evidence: `src/App.jsx`)
- Route application → Private route guard: guards routes (evidence: `src/App.jsx`)
- Private route guard → Create shipment: renders when signed in (evidence: `src/App.jsx`)
- Private route guard → My shipments: renders when signed in (evidence: `src/App.jsx`)
- Route application → Shipment tracking: routes to (evidence: `src/App.jsx`)
- Route application → Shipment dashboard: routes when admin (evidence: `src/App.jsx`)
- Route application → Auth state: provides auth state (evidence: `src/App.jsx`)
- Route application → Admin email list: checks admin email (evidence: `src/App.jsx`)
- Navigation bar → User profile: shows profile (evidence: `src/components/Navbar.jsx`)
- Navigation bar → Admin email list: checks admin email (evidence: `src/components/Navbar.jsx`)
- Auth state → Firebase setup: observes auth (evidence: `src/context/AuthContext.jsx`)
- Firebase setup → Firebase Auth: initializes (evidence: `src/config/firebase.js`)
- Firebase setup → Shipment records: initializes (evidence: `src/config/firebase.js`)
- User login → Firebase setup: uses Firebase (evidence: `src/pages/Login.jsx`)
- Registration → Firebase setup: uses Firebase (evidence: `src/pages/Register.jsx`)
- Admin login → Firebase setup: uses Firebase (evidence: `src/pages/AdminLogin.jsx`)
- Admin login → Admin email list: checks admin access (evidence: `src/pages/AdminLogin.jsx`)
- Admin route guard → Auth state: checks signed-in user (evidence: `src/components/AdminRoute.jsx`)
- Admin route guard → Admin email list: checks admin access (evidence: `src/components/AdminRoute.jsx`)
- User profile → Auth state: reads user state (evidence: `src/components/UserProfile.jsx`)
- User profile → Firebase setup: signs out (evidence: `src/components/UserProfile.jsx`)
- Create shipment → Auth state: reads current user (evidence: `src/pages/CreateShipment.jsx`)
- Create shipment → Shipment records: creates shipment (evidence: `src/pages/CreateShipment.jsx`)
- Create shipment → EmailJS service: sends OTP (evidence: `src/pages/CreateShipment.jsx`)
- My shipments → Auth state: reads current user (evidence: `src/pages/Shipments.jsx`)
- My shipments → Shipment records: reads and updates shipments (evidence: `src/pages/Shipments.jsx`)
- My shipments → Shipment tracking: links to track (evidence: `src/pages/Shipments.jsx`)
- Shipment tracking → Firebase setup: uses Firebase (evidence: `src/pages/TrackShipment.jsx`)
- Shipment dashboard → Shipment records: reads and updates records (evidence: `src/pages/AdminDashboard.jsx`)
