# sonalpal/pink-alert architecture

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

- Interactive diagram: https://gitdiagram.com/sonalpal/pink-alert
- Repository: https://github.com/sonalpal/pink-alert

## Overview

SafeHer India is a women-first travel-safety application. The principal workflow is account signup and email verification, followed by authenticated access to a dashboard, nearby safety places, guardian management, and SOS alerts. The frontend routes users to these experiences and its API client sends requests to an Express backend, whose controllers coordinate persistence and external services. Wellness guides and safety news are separate product branches documented in the README. Backend feature links follow the route/controller references; details of several unsampled pages and SOS behavior are therefore not expanded beyond documented capabilities.

Main entry points: [`frontend/src/router/Router.jsx`](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/router/Router.jsx) (App router), [`backend/src/server.js`](https://github.com/sonalpal/pink-alert/blob/main/backend/src/server.js) (Express API), [`frontend/src/utils/api.js`](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/utils/api.js) (API client), [`backend/src/controllers/authController.js`](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/authController.js) (Account controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Frontend experience"]
  node_router["App router<br/>[Router.jsx]"]
  node_signup["Signup flow<br/>[Signup.jsx]"]
  node_authstate["Auth state<br/>[useAuth.js]"]
  node_api_client["API client<br/>[api.js]"]
  node_dashboard["Dashboard<br/>[Dashboard.jsx]"]
  node_map_page["Safety map<br/>[Map.jsx]"]
  node_sos_page["SOS screen<br/>[SOS.jsx]"]
  node_guardians_page["Guardian network"]
  node_wellness["Wellness guides<br/>[WellnessPage.jsx]"]
  node_news["Safety news"]
  node_settings["Account settings<br/>[SettingsPage.jsx]"]
end

subgraph group_api["Backend API"]
  node_backend["Express API<br/>[server.js]"]
  node_auth_routes["Auth routes<br/>[authRoutes.js]"]
  node_guardian_routes["Guardian routes<br/>[guardianRoutes.js]"]
  node_location_routes["Location routes<br/>[locationRoutes.js]"]
  node_sos_routes["SOS routes<br/>[sosRoutes.js]"]
  node_activity_routes["Activity routes<br/>[activityRoutes.js]"]
end

subgraph group_domain["Safety services and data"]
  node_auth_ctrl["Account controller<br/>[authController.js]"]
  node_guardian_ctrl["Guardian controller"]
  node_location_ctrl["Location controller"]
  node_sos_ctrl["SOS controller<br/>[sosController.js]"]
  node_activity_ctrl["Activity logging"]
  node_user_store[("User records<br/>[User.js]")]
  node_guardian_store[("Guardian records<br/>[Guardian.js]")]
  node_sos_store[("SOS records<br/>[SOS.js]")]
  node_activity_store[("Activity records<br/>[Activity.js]")]
end

subgraph group_external["External services"]
  node_email["Email service<br/>[emailService.js]"]
  node_overpass["Overpass places<br/>[overpassService.js]"]
end

node_traveler(("Traveler"))
node_mongodb[("MongoDB")]

node_traveler -->|"uses"| node_router
node_router -->|"routes to"| node_signup
node_router -->|"routes to"| node_dashboard
node_router -->|"routes to"| node_map_page
node_router -->|"routes to"| node_sos_page
node_router -->|"routes to"| node_guardians_page
node_router -->|"routes to"| node_wellness
node_router -->|"routes to"| node_news
node_router -->|"routes to"| node_settings
node_router -->|"checks auth"| node_authstate
node_signup -->|"submits via"| node_api_client
node_authstate -->|"requests user"| node_api_client
node_api_client -->|"sends API requests"| node_backend
node_backend -->|"mounts routes"| node_auth_routes
node_backend -->|"mounts routes"| node_guardian_routes
node_backend -->|"mounts routes"| node_location_routes
node_backend -->|"mounts routes"| node_sos_routes
node_backend -->|"mounts routes"| node_activity_routes
node_auth_routes -->|"dispatches"| node_auth_ctrl
node_guardian_routes -->|"dispatches"| node_guardian_ctrl
node_location_routes -->|"dispatches"| node_location_ctrl
node_sos_routes -->|"dispatches"| node_sos_ctrl
node_activity_routes -->|"dispatches"| node_activity_ctrl
node_auth_ctrl -->|"reads and writes"| node_user_store
node_auth_ctrl -->|"creates guardian"| node_guardian_store
node_auth_ctrl -->|"sends verification"| node_email
node_auth_ctrl -->|"logs activity"| node_activity_ctrl
node_guardian_ctrl -->|"manages records"| node_guardian_store
node_location_ctrl -->|"fetches places"| node_overpass
node_location_ctrl -->|"logs map use"| node_activity_ctrl
node_sos_ctrl -->|"manages alerts"| node_sos_store
node_sos_ctrl -->|"uses guardians"| node_guardian_store
node_sos_ctrl -->|"logs activity"| node_activity_ctrl
node_activity_ctrl -->|"reads and writes"| node_activity_store
node_backend -->|"connects database"| node_mongodb
node_sos_page -.->|"triggers alerts"| node_api_client
node_map_page -.->|"requests places"| node_api_client
node_guardians_page -.->|"manages contacts"| node_api_client

click node_router "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/router/Router.jsx"
click node_signup "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/components/Signup.jsx"
click node_authstate "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/hooks/useAuth.js"
click node_api_client "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/utils/api.js"
click node_dashboard "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/Dashboard.jsx"
click node_map_page "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/Map.jsx"
click node_sos_page "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/SOS.jsx"
click node_guardians_page "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/GuardianNetworkPage.jsx"
click node_wellness "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/WellnessPage.jsx"
click node_news "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/CurrentAffairsPage.jsx"
click node_settings "https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/SettingsPage.jsx"
click node_backend "https://github.com/sonalpal/pink-alert/blob/main/backend/src/server.js"
click node_auth_routes "https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/authRoutes.js"
click node_guardian_routes "https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/guardianRoutes.js"
click node_location_routes "https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/locationRoutes.js"
click node_sos_routes "https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/sosRoutes.js"
click node_activity_routes "https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/activityRoutes.js"
click node_auth_ctrl "https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/authController.js"
click node_guardian_ctrl "https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/guardianController.js"
click node_location_ctrl "https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/locationController.js"
click node_sos_ctrl "https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/sosController.js"
click node_activity_ctrl "https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/activityController.js"
click node_user_store "https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/User.js"
click node_guardian_store "https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/Guardian.js"
click node_sos_store "https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/SOS.js"
click node_activity_store "https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/Activity.js"
click node_email "https://github.com/sonalpal/pink-alert/blob/main/backend/src/services/emailService.js"
click node_overpass "https://github.com/sonalpal/pink-alert/blob/main/backend/src/services/overpassService.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_router,node_signup,node_authstate,node_api_client,node_dashboard,node_map_page,node_sos_page,node_guardians_page,node_wellness,node_news,node_settings toneBlue
class node_backend,node_auth_routes,node_guardian_routes,node_location_routes,node_sos_routes,node_activity_routes,node_mongodb toneAmber
class node_auth_ctrl,node_guardian_ctrl,node_location_ctrl,node_sos_ctrl,node_activity_ctrl,node_user_store,node_guardian_store,node_sos_store,node_activity_store toneMint
class node_email,node_overpass toneRose
class node_traveler toneIndigo
```

## Components

### Frontend experience

- [App router](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/router/Router.jsx): `frontend/src/router/Router.jsx`
- [Signup flow](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/components/Signup.jsx): `frontend/src/components/Signup.jsx`
- [Auth state](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/hooks/useAuth.js): `frontend/src/hooks/useAuth.js`
- [API client](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/utils/api.js): `frontend/src/utils/api.js`
- [Dashboard](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/Dashboard.jsx): `frontend/src/pages/Dashboard.jsx`
- [Safety map](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/Map.jsx): `frontend/src/pages/Map.jsx`
- [SOS screen](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/SOS.jsx): `frontend/src/pages/SOS.jsx`
- [Guardian network](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/GuardianNetworkPage.jsx): `frontend/src/pages/GuardianNetworkPage.jsx`
- [Wellness guides](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/WellnessPage.jsx): `frontend/src/pages/WellnessPage.jsx`
- [Safety news](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/CurrentAffairsPage.jsx): `frontend/src/pages/CurrentAffairsPage.jsx`
- [Account settings](https://github.com/sonalpal/pink-alert/blob/main/frontend/src/pages/SettingsPage.jsx): `frontend/src/pages/SettingsPage.jsx`

### Backend API

- [Express API](https://github.com/sonalpal/pink-alert/blob/main/backend/src/server.js): `backend/src/server.js`
- [Auth routes](https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/authRoutes.js): `backend/src/routes/authRoutes.js`
- [Guardian routes](https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/guardianRoutes.js): `backend/src/routes/guardianRoutes.js`
- [Location routes](https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/locationRoutes.js): `backend/src/routes/locationRoutes.js`
- [SOS routes](https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/sosRoutes.js): `backend/src/routes/sosRoutes.js`
- [Activity routes](https://github.com/sonalpal/pink-alert/blob/main/backend/src/routes/activityRoutes.js): `backend/src/routes/activityRoutes.js`

### Safety services and data

- [Account controller](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/authController.js): `backend/src/controllers/authController.js`
- [Guardian controller](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/guardianController.js): `backend/src/controllers/guardianController.js`
- [Location controller](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/locationController.js): `backend/src/controllers/locationController.js`
- [SOS controller](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/sosController.js): `backend/src/controllers/sosController.js`
- [Activity logging](https://github.com/sonalpal/pink-alert/blob/main/backend/src/controllers/activityController.js): `backend/src/controllers/activityController.js`
- [User records](https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/User.js): `backend/src/models/User.js`
- [Guardian records](https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/Guardian.js): `backend/src/models/Guardian.js`
- [SOS records](https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/SOS.js): `backend/src/models/SOS.js`
- [Activity records](https://github.com/sonalpal/pink-alert/blob/main/backend/src/models/Activity.js): `backend/src/models/Activity.js`

### External services

- [Email service](https://github.com/sonalpal/pink-alert/blob/main/backend/src/services/emailService.js): `backend/src/services/emailService.js`
- [Overpass places](https://github.com/sonalpal/pink-alert/blob/main/backend/src/services/overpassService.js): `backend/src/services/overpassService.js`

### Other components

- **Traveler**
- **MongoDB**

## Connections

- Traveler → App router: uses (evidence: `frontend/src/router/Router.jsx`)
- App router → Signup flow: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Dashboard: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Safety map: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → SOS screen: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Guardian network: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Wellness guides: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Safety news: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Account settings: routes to (evidence: `frontend/src/router/Router.jsx`)
- App router → Auth state: checks auth (evidence: `frontend/src/router/Router.jsx`)
- Signup flow → API client: submits via (evidence: `frontend/src/components/Signup.jsx`)
- Auth state → API client: requests user (evidence: `frontend/src/hooks/useAuth.js`)
- API client → Express API: sends API requests (evidence: `frontend/src/utils/api.js`)
- Express API → Auth routes: mounts routes (evidence: `backend/src/server.js`)
- Express API → Guardian routes: mounts routes (evidence: `backend/src/server.js`)
- Express API → Location routes: mounts routes (evidence: `backend/src/server.js`)
- Express API → SOS routes: mounts routes (evidence: `backend/src/server.js`)
- Express API → Activity routes: mounts routes (evidence: `backend/src/server.js`)
- Auth routes → Account controller: dispatches (evidence: `backend/src/routes/authRoutes.js`)
- Guardian routes → Guardian controller: dispatches (evidence: `backend/src/routes/guardianRoutes.js`)
- Location routes → Location controller: dispatches (evidence: `backend/src/routes/locationRoutes.js`)
- SOS routes → SOS controller: dispatches (evidence: `backend/src/routes/sosRoutes.js`)
- Activity routes → Activity logging: dispatches (evidence: `backend/src/routes/activityRoutes.js`)
- Account controller → User records: reads and writes (evidence: `backend/src/controllers/authController.js`)
- Account controller → Guardian records: creates guardian (evidence: `backend/src/controllers/authController.js`)
- Account controller → Email service: sends verification (evidence: `backend/src/controllers/authController.js`)
- Account controller → Activity logging: logs activity (evidence: `backend/src/controllers/authController.js`)
- Guardian controller → Guardian records: manages records (evidence: `backend/src/controllers/guardianController.js`)
- Location controller → Overpass places: fetches places (evidence: `backend/src/controllers/locationController.js`)
- Location controller → Activity logging: logs map use (evidence: `backend/src/controllers/locationController.js`)
- SOS controller → SOS records: manages alerts (evidence: `backend/src/controllers/sosController.js`)
- SOS controller → Guardian records: uses guardians (evidence: `backend/src/controllers/sosController.js`)
- SOS controller → Activity logging: logs activity (evidence: `backend/src/controllers/sosController.js`)
- Activity logging → Activity records: reads and writes (evidence: `backend/src/controllers/activityController.js`)
- Express API → MongoDB: connects database (evidence: `backend/src/server.js`)
- SOS screen → API client: triggers alerts
- Safety map → API client: requests places
- Guardian network → API client: manages contacts
