# faisalmushtaq/myphone-mybrain architecture

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

## Overview

MyPhone/MyBrain is a research-project website and participant platform. The public site directs families to the opt-in consent and phone-use donation flow; the app saves consent as soon as it is complete, then supports screenshot donation and later completion. Separate branches support the adult social-media-break study, a New Year study, and research-team operations. The graph combines README-documented capabilities with sampled app and function relationships; unsampled implementations are represented only where the README documents them, and evidence limits are reflected in the edges.

Main entry points: [`consent-app/src/App.tsx`](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/App.tsx) (Consent journey), [`consent-app/src/api/index.ts`](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/api/index.ts) (API selection), [`consent-app/firebase/functions/src/portal.ts`](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/portal.ts) (Portal functions), [`_plugins/school_pages.rb`](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/_plugins/school_pages.rb) (Project website)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Public website"]
  node_website["Project website<br/>[school_pages.rb]"]
  node_schoolpages["School pages<br/>[school_pages.rb]"]
end

subgraph group_family["Family consent"]
  node_consentui["Consent journey<br/>[App.tsx]"]
  node_journey["Journey rules<br/>[journey.ts]"]
  node_state["App state<br/>[context.tsx]"]
  node_sync["Consent submission<br/>[useSync.ts]"]
  node_uploader["Screenshot upload<br/>[useUploader.ts]"]
  node_api["API selection<br/>[index.ts]"]
  node_backend["Mock or Firebase<br/>[types.ts]"]
end

subgraph group_lab["Break study"]
  node_labapp["Break-study journey<br/>[LabApp.tsx]"]
  node_labsender["Lab donations<br/>[useLabSender.ts]"]
  node_labserver["Lab functions<br/>[lab.ts]"]
  node_newyear["New Year study<br/>[NewYearApp.tsx]"]
end

subgraph group_operations["Research operations"]
  node_staff["Staff portal<br/>[TeamViews.tsx]"]
  node_portalfunctions["Portal functions<br/>[portal.ts]"]
  node_portalrules["Portal rules<br/>[portalCore.ts]"]
  node_exports["Study exports<br/>[export.ts]"]
  node_enquiries["Enquiry handling<br/>[enquiry.ts]"]
  node_firestore[("Firestore")]
end

node_families(("Families"))
node_team(("Research team"))

node_families -->|"visits"| node_website
node_website -->|"generates"| node_schoolpages
node_schoolpages -->|"links to"| node_consentui
node_families -->|"completes"| node_consentui
node_consentui -->|"builds steps"| node_journey
node_consentui -->|"reads state"| node_state
node_state -->|"coordinates saving"| node_sync
node_sync -->|"submits consent"| node_api
node_api -->|"selects backend"| node_backend
node_consentui -->|"collects screenshots"| node_uploader
node_uploader -->|"uploads files"| node_api
node_families -->|"joins break study"| node_labapp
node_labapp -.->|"sends donations"| node_labsender
node_labsender -->|"submits donation"| node_api
node_api -.->|"routes lab calls"| node_labserver
node_families -->|"joins study"| node_newyear
node_team -->|"manages study"| node_staff
node_staff -->|"uses portal API"| node_portalfunctions
node_portalfunctions -->|"calls rules"| node_portalrules
node_portalfunctions -->|"reads and writes"| node_firestore
node_portalfunctions -->|"sends email and notices"| node_team
node_team -.->|"uses study data"| node_exports
node_exports -->|"reads records"| node_firestore
node_website -->|"posts enquiries"| node_enquiries
node_enquiries -->|"stores enquiries"| node_firestore
node_enquiries -->|"emails team"| node_team

click node_website "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/_plugins/school_pages.rb"
click node_schoolpages "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/_plugins/school_pages.rb"
click node_consentui "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/App.tsx"
click node_journey "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/model/journey.ts"
click node_state "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/context.tsx"
click node_sync "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/useSync.ts"
click node_uploader "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/useUploader.ts"
click node_api "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/api/index.ts"
click node_backend "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/api/types.ts"
click node_labapp "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/lab/LabApp.tsx"
click node_labsender "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/lab/useLabSender.ts"
click node_labserver "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/lab.ts"
click node_newyear "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/newyear/NewYearApp.tsx"
click node_staff "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/portal/TeamViews.tsx"
click node_portalfunctions "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/portal.ts"
click node_portalrules "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/portalCore.ts"
click node_exports "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/export.ts"
click node_enquiries "https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/enquiry.ts"

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_website,node_schoolpages toneBlue
class node_consentui,node_journey,node_state,node_sync,node_uploader,node_api,node_backend toneAmber
class node_labapp,node_labsender,node_labserver,node_newyear toneMint
class node_staff,node_portalfunctions,node_portalrules,node_exports,node_enquiries,node_firestore toneRose
class node_families,node_team toneIndigo
```

## Components

### Public website

- [Project website](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/_plugins/school_pages.rb): `_plugins/school_pages.rb`
- [School pages](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/_plugins/school_pages.rb): `_plugins/school_pages.rb`

### Family consent

- [Consent journey](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/App.tsx): `consent-app/src/App.tsx`
- [Journey rules](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/model/journey.ts): `consent-app/src/model/journey.ts`
- [App state](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/context.tsx): `consent-app/src/state/context.tsx`
- [Consent submission](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/useSync.ts): `consent-app/src/state/useSync.ts`
- [Screenshot upload](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/state/useUploader.ts): `consent-app/src/state/useUploader.ts`
- [API selection](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/api/index.ts): `consent-app/src/api/index.ts`
- [Mock or Firebase](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/api/types.ts): `consent-app/src/api/types.ts`

### Break study

- [Break-study journey](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/lab/LabApp.tsx): `consent-app/src/lab/LabApp.tsx`
- [Lab donations](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/lab/useLabSender.ts): `consent-app/src/lab/useLabSender.ts`
- [Lab functions](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/lab.ts): `consent-app/firebase/functions/src/lab.ts`
- [New Year study](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/newyear/NewYearApp.tsx): `consent-app/src/newyear/NewYearApp.tsx`

### Research operations

- [Staff portal](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/src/portal/TeamViews.tsx): `consent-app/src/portal/TeamViews.tsx`
- [Portal functions](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/portal.ts): `consent-app/firebase/functions/src/portal.ts`
- [Portal rules](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/portalCore.ts): `consent-app/firebase/functions/src/portalCore.ts`
- [Study exports](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/export.ts): `consent-app/firebase/functions/src/export.ts`
- [Enquiry handling](https://github.com/faisalmushtaq/myphone-mybrain/blob/main/consent-app/firebase/functions/src/enquiry.ts): `consent-app/firebase/functions/src/enquiry.ts`
- **Firestore**

### Other components

- **Families**
- **Research team**

## Connections

- Families → Project website: visits
- Project website → School pages: generates (evidence: `_plugins/school_pages.rb`)
- School pages → Consent journey: links to
- Families → Consent journey: completes
- Consent journey → Journey rules: builds steps (evidence: `consent-app/src/App.tsx`)
- Consent journey → App state: reads state (evidence: `consent-app/src/App.tsx`)
- App state → Consent submission: coordinates saving (evidence: `consent-app/src/state/context.tsx`)
- Consent submission → API selection: submits consent (evidence: `consent-app/src/state/useSync.ts`)
- API selection → Mock or Firebase: selects backend (evidence: `consent-app/src/api/index.ts`)
- Consent journey → Screenshot upload: collects screenshots
- Screenshot upload → API selection: uploads files (evidence: `consent-app/src/state/useUploader.ts`)
- Families → Break-study journey: joins break study
- Break-study journey → Lab donations: sends donations
- Lab donations → API selection: submits donation (evidence: `consent-app/src/lab/useLabSender.ts`)
- API selection → Lab functions: routes lab calls
- Families → New Year study: joins study
- Research team → Staff portal: manages study
- Staff portal → Portal functions: uses portal API (evidence: `consent-app/src/portal/TeamViews.tsx`)
- Portal functions → Portal rules: calls rules (evidence: `consent-app/firebase/functions/src/portalCore.ts`)
- Portal functions → Firestore: reads and writes (evidence: `consent-app/firebase/functions/src/portal.ts`)
- Portal functions → Research team: sends email and notices (evidence: `consent-app/firebase/functions/src/portal.ts`)
- Research team → Study exports: uses study data
- Study exports → Firestore: reads records (evidence: `consent-app/firebase/functions/src/export.ts`)
- Project website → Enquiry handling: posts enquiries
- Enquiry handling → Firestore: stores enquiries
- Enquiry handling → Research team: emails team
