# ankit-basu/sheshield architecture

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

## Overview

SheShield is a campus-safety product with web and React Native clients backed by PHP APIs and MySQL. Its main user journey spans sign-in, incident reporting and follow-up, SOS, campus safety mapping, safe spaces, and companion-walk requests; administrators review incidents and verify or assign walkers. The graph groups features by domain and includes authentication, persistence, and email as internal layers. Some endpoint implementations and mobile screens were not sampled, so those feature connections rely on README documentation rather than inferred call chains.

Main entry points: [`mobile/src/app/(tabs)/index.tsx`](https://github.com/ankit-basu/sheshield/blob/master/mobile/src/app/(tabs)/index.tsx) (Mobile app), [`app/middleware/session_bootstrap.php`](https://github.com/ankit-basu/sheshield/blob/master/app/middleware/session_bootstrap.php) (Session and tokens), [`api/auth/firebase-login.php`](https://github.com/ankit-basu/sheshield/blob/master/api/auth/firebase-login.php) (Authentication API), [`api/incidents/create.php`](https://github.com/ankit-basu/sheshield/blob/master/api/incidents/create.php) (Incident reporting)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_clients["User applications"]
  node_web["Web experience<br/>[_layout.php]"]
  node_mobile["Mobile app<br/>[index.tsx]"]
  node_authui["Mobile sign-in<br/>[AuthForm.tsx]"]
  node_layout["Web navigation<br/>[sidebar.php]"]
  node_mobiletext["Mobile text UI<br/>[Text.tsx]"]
end

subgraph group_identity["Identity and profiles"]
  node_authapi["Authentication API<br/>[firebase-login.php]"]
  node_users["User accounts<br/>[User.php]"]
  node_session["Session and tokens"]
  node_profile["Profile management<br/>[update_profile.php]"]
end

subgraph group_incidents["Incident response"]
  node_admin["Admin console<br/>[index.php]"]
  node_reports["Incident reporting<br/>[create.php]"]
  node_incidentmodel["Incident records<br/>[Incident.php]"]
  node_adminreview["Incident administration<br/>[view_incident.php]"]
end

subgraph group_campus["Campus safety"]
  node_sos["Emergency SOS<br/>[alert.php]"]
  node_map["Campus safety map<br/>[map.tsx]"]
  node_safe["Safe spaces<br/>[save_zone.php]"]
end

subgraph group_walks["Walk companion"]
  node_walkrequest["Walk requests<br/>[create_request.php]"]
  node_walkadmin["Walker verification<br/>[admin_action.php]"]
  node_walkemail["Walk email notices"]
end

subgraph group_platform["Shared platform"]
  node_mailer["Email delivery<br/>[mailer.php]"]
  node_mailtransport["PHPMailer transport<br/>[PHPMailer.php]"]
  node_database[("PDO database<br/>[database.php]")]
  node_mysqli[("MySQLi database<br/>[mysqli_db.php]")]
  node_dbwrapper["Database adapter<br/>[mysqli_db.php]"]
end

node_visitor(("Campus user"))

node_visitor -->|"uses"| node_web
node_visitor -->|"uses"| node_mobile
node_web -->|"renders"| node_layout
node_authui -.->|"signs in"| node_authapi
node_mobile -.->|"uses API"| node_authapi
node_mobile -.->|"submits reports"| node_reports
node_mobile -.->|"requests walks"| node_walkrequest
node_mobile -.->|"sends alerts"| node_sos
node_authapi -->|"authenticates"| node_users
node_authapi -->|"issues tokens"| node_session
node_session -->|"reads tokens"| node_database
node_profile -->|"requires identity"| node_session
node_reports -->|"starts session"| node_session
node_reports -->|"creates report"| node_incidentmodel
node_incidentmodel -.->|"stores incidents"| node_database
node_admin -->|"opens details"| node_adminreview
node_admin -->|"loads incidents"| node_incidentmodel
node_admin -->|"updates status"| node_reports
node_visitor -->|"requests help"| node_sos
node_visitor -->|"views campus"| node_map
node_visitor -->|"marks zones"| node_safe
node_walkrequest -.->|"checks identity"| node_session
node_walkadmin -->|"assigns walkers"| node_walkrequest
node_walkrequest -->|"sends confirmation"| node_walkemail
node_walkemail -->|"sends mail"| node_mailer
node_mailer -->|"uses SMTP"| node_mailtransport
node_dbwrapper -->|"gets connection"| node_mysqli
node_mysqli -.->|"loads schema config"| node_database
node_web -.->|"shares UI patterns"| node_mobiletext

click node_web "https://github.com/ankit-basu/sheshield/blob/master/views/pages/_layout.php"
click node_mobile "https://github.com/ankit-basu/sheshield/blob/master/mobile/src/app/(tabs)/index.tsx"
click node_admin "https://github.com/ankit-basu/sheshield/blob/master/admin/index.php"
click node_authui "https://github.com/ankit-basu/sheshield/blob/master/mobile/src/components/AuthForm.tsx"
click node_authapi "https://github.com/ankit-basu/sheshield/blob/master/api/auth/firebase-login.php"
click node_users "https://github.com/ankit-basu/sheshield/blob/master/app/models/User.php"
click node_session "https://github.com/ankit-basu/sheshield/blob/master/app/middleware/session_bootstrap.php"
click node_profile "https://github.com/ankit-basu/sheshield/blob/master/api/user/update_profile.php"
click node_sos "https://github.com/ankit-basu/sheshield/blob/master/api/emergency/alert.php"
click node_map "https://github.com/ankit-basu/sheshield/blob/master/mobile/src/app/(tabs)/map.tsx"
click node_safe "https://github.com/ankit-basu/sheshield/blob/master/api/safespaces/save_zone.php"
click node_reports "https://github.com/ankit-basu/sheshield/blob/master/api/incidents/create.php"
click node_incidentmodel "https://github.com/ankit-basu/sheshield/blob/master/app/models/Incident.php"
click node_adminreview "https://github.com/ankit-basu/sheshield/blob/master/admin/view_incident.php"
click node_walkrequest "https://github.com/ankit-basu/sheshield/blob/master/api/walks/create_request.php"
click node_walkadmin "https://github.com/ankit-basu/sheshield/blob/master/api/walks/admin_action.php"
click node_walkemail "https://github.com/ankit-basu/sheshield/blob/master/api/walks/send_walk_email.php"
click node_mailer "https://github.com/ankit-basu/sheshield/blob/master/app/helpers/mailer.php"
click node_mailtransport "https://github.com/ankit-basu/sheshield/blob/master/app/lib/PHPMailer/PHPMailer.php"
click node_database "https://github.com/ankit-basu/sheshield/blob/master/app/config/database.php"
click node_mysqli "https://github.com/ankit-basu/sheshield/blob/master/database/mysqli_db.php"
click node_dbwrapper "https://github.com/ankit-basu/sheshield/blob/master/app/models/mysqli_db.php"
click node_layout "https://github.com/ankit-basu/sheshield/blob/master/views/pages/sidebar.php"
click node_mobiletext "https://github.com/ankit-basu/sheshield/blob/master/mobile/src/components/Text.tsx"

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_web,node_mobile,node_authui,node_layout,node_mobiletext,node_visitor toneBlue
class node_authapi,node_users,node_session,node_profile toneAmber
class node_admin,node_reports,node_incidentmodel,node_adminreview toneMint
class node_sos,node_map,node_safe toneRose
class node_walkrequest,node_walkadmin,node_walkemail toneIndigo
class node_mailer,node_mailtransport,node_database,node_mysqli,node_dbwrapper toneTeal
```

## Components

### User applications

- [Web experience](https://github.com/ankit-basu/sheshield/blob/master/views/pages/_layout.php): `views/pages/_layout.php`
- [Mobile app](https://github.com/ankit-basu/sheshield/blob/master/mobile/src/app/(tabs)/index.tsx): `mobile/src/app/(tabs)/index.tsx`
- [Mobile sign-in](https://github.com/ankit-basu/sheshield/blob/master/mobile/src/components/AuthForm.tsx): `mobile/src/components/AuthForm.tsx`
- [Web navigation](https://github.com/ankit-basu/sheshield/blob/master/views/pages/sidebar.php): `views/pages/sidebar.php`
- [Mobile text UI](https://github.com/ankit-basu/sheshield/blob/master/mobile/src/components/Text.tsx): `mobile/src/components/Text.tsx`

### Identity and profiles

- [Authentication API](https://github.com/ankit-basu/sheshield/blob/master/api/auth/firebase-login.php): `api/auth/firebase-login.php`
- [User accounts](https://github.com/ankit-basu/sheshield/blob/master/app/models/User.php): `app/models/User.php`
- [Session and tokens](https://github.com/ankit-basu/sheshield/blob/master/app/middleware/session_bootstrap.php): `app/middleware/session_bootstrap.php`
- [Profile management](https://github.com/ankit-basu/sheshield/blob/master/api/user/update_profile.php): `api/user/update_profile.php`

### Incident response

- [Admin console](https://github.com/ankit-basu/sheshield/blob/master/admin/index.php): `admin/index.php`
- [Incident reporting](https://github.com/ankit-basu/sheshield/blob/master/api/incidents/create.php): `api/incidents/create.php`
- [Incident records](https://github.com/ankit-basu/sheshield/blob/master/app/models/Incident.php): `app/models/Incident.php`
- [Incident administration](https://github.com/ankit-basu/sheshield/blob/master/admin/view_incident.php): `admin/view_incident.php`

### Campus safety

- [Emergency SOS](https://github.com/ankit-basu/sheshield/blob/master/api/emergency/alert.php): `api/emergency/alert.php`
- [Campus safety map](https://github.com/ankit-basu/sheshield/blob/master/mobile/src/app/(tabs)/map.tsx): `mobile/src/app/(tabs)/map.tsx`
- [Safe spaces](https://github.com/ankit-basu/sheshield/blob/master/api/safespaces/save_zone.php): `api/safespaces/save_zone.php`

### Walk companion

- [Walk requests](https://github.com/ankit-basu/sheshield/blob/master/api/walks/create_request.php): `api/walks/create_request.php`
- [Walker verification](https://github.com/ankit-basu/sheshield/blob/master/api/walks/admin_action.php): `api/walks/admin_action.php`
- [Walk email notices](https://github.com/ankit-basu/sheshield/blob/master/api/walks/send_walk_email.php): `api/walks/send_walk_email.php`

### Shared platform

- [Email delivery](https://github.com/ankit-basu/sheshield/blob/master/app/helpers/mailer.php): `app/helpers/mailer.php`
- [PHPMailer transport](https://github.com/ankit-basu/sheshield/blob/master/app/lib/PHPMailer/PHPMailer.php): `app/lib/PHPMailer/PHPMailer.php`
- [PDO database](https://github.com/ankit-basu/sheshield/blob/master/app/config/database.php): `app/config/database.php`
- [MySQLi database](https://github.com/ankit-basu/sheshield/blob/master/database/mysqli_db.php): `database/mysqli_db.php`
- [Database adapter](https://github.com/ankit-basu/sheshield/blob/master/app/models/mysqli_db.php): `app/models/mysqli_db.php`

### Other components

- **Campus user**

## Connections

- Campus user → Web experience: uses
- Campus user → Mobile app: uses
- Web experience → Web navigation: renders (evidence: `views/pages/_layout.php`)
- Mobile sign-in → Authentication API: signs in
- Mobile app → Authentication API: uses API
- Mobile app → Incident reporting: submits reports
- Mobile app → Walk requests: requests walks
- Mobile app → Emergency SOS: sends alerts
- Authentication API → User accounts: authenticates (evidence: `api/auth/firebase-login.php`)
- Authentication API → Session and tokens: issues tokens (evidence: `api/auth/firebase-login.php`)
- Session and tokens → PDO database: reads tokens (evidence: `app/middleware/session_bootstrap.php`)
- Profile management → Session and tokens: requires identity
- Incident reporting → Session and tokens: starts session (evidence: `api/incidents/create.php`)
- Incident reporting → Incident records: creates report (evidence: `api/incidents/create.php`)
- Incident records → PDO database: stores incidents
- Admin console → Incident administration: opens details (evidence: `admin/index.php`)
- Admin console → Incident records: loads incidents (evidence: `admin/index.php`)
- Admin console → Incident reporting: updates status (evidence: `admin/index.php`)
- Campus user → Emergency SOS: requests help
- Campus user → Campus safety map: views campus
- Campus user → Safe spaces: marks zones
- Walk requests → Session and tokens: checks identity
- Walker verification → Walk requests: assigns walkers
- Walk requests → Walk email notices: sends confirmation (evidence: `api/walks/send_walk_email.php`)
- Walk email notices → Email delivery: sends mail (evidence: `api/walks/send_walk_email.php`)
- Email delivery → PHPMailer transport: uses SMTP (evidence: `app/helpers/mailer.php`)
- Database adapter → MySQLi database: gets connection (evidence: `app/models/mysqli_db.php`)
- MySQLi database → PDO database: loads schema config
- Web experience → Mobile text UI: shares UI patterns
