# nyikomnisii/studymate architecture

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

- Interactive diagram: https://gitdiagram.com/nyikomnisii/studymate
- Repository: https://github.com/nyikomnisii/studymate

## Overview

StudyMate is an Android study-materials app for South African Grade 12 students. The documented user journey is to open the app, navigate materials by subject, and access textbook, past-paper, or study-guide PDFs. The README also describes Firebase, push notifications, ads, and remote JSON configuration, plus four planned learning features. Only the README is present in the supplied tree, so component paths point to that documentation; implementation details and unshown runtime call relationships cannot be verified.

Main entry points: [`README.md`](https://github.com/nyikomnisii/studymate/blob/main/README.md) (StudyMate app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Study materials"]
  node_studymate["StudyMate app<br/>[README.md]"]
  node_subjects["Subject navigation<br/>[README.md]"]
  node_materials["PDF study materials<br/>[README.md]"]
end

subgraph group_integrations["App integrations"]
  node_firebase_auth["Firebase authentication<br/>[README.md]"]
  node_firebase_db[("Firebase realtime database<br/>[README.md]")]
  node_onesignal["OneSignal notifications<br/>[README.md]"]
  node_admob["AdMob ads<br/>[README.md]"]
  node_remote_config["Remote JSON config<br/>[README.md]"]
end

subgraph group_planned["Planned features"]
  node_progress["Progress tracking<br/>[README.md]"]
  node_forums["Discussion forums<br/>[README.md]"]
  node_timetable["Timetable generator<br/>[README.md]"]
  node_career["Career guidance<br/>[README.md]"]
end

node_student(("Grade 12 student"))

node_student -->|"uses"| node_studymate
node_studymate -->|"offers navigation"| node_subjects
node_studymate -->|"provides PDFs"| node_materials
node_studymate -->|"uses authentication"| node_firebase_auth
node_studymate -->|"uses database"| node_firebase_db
node_studymate -->|"integrates notifications"| node_onesignal
node_studymate -->|"shows ads"| node_admob
node_studymate -->|"fetches configuration"| node_remote_config
node_studymate -.->|"plans tracking"| node_progress
node_studymate -.->|"plans forums"| node_forums
node_studymate -.->|"plans generation"| node_timetable
node_studymate -.->|"plans guidance"| node_career

click node_studymate "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_subjects "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_materials "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_firebase_auth "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_firebase_db "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_onesignal "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_admob "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_remote_config "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_progress "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_forums "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_timetable "https://github.com/nyikomnisii/studymate/blob/main/README.md"
click node_career "https://github.com/nyikomnisii/studymate/blob/main/README.md"

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_studymate,node_subjects,node_materials toneBlue
class node_firebase_auth,node_firebase_db,node_onesignal,node_admob,node_remote_config toneAmber
class node_progress,node_forums,node_timetable,node_career toneMint
class node_student toneIndigo
```

## Components

### Study materials

- [StudyMate app](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Subject navigation](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [PDF study materials](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`

### App integrations

- [Firebase authentication](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Firebase realtime database](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [OneSignal notifications](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [AdMob ads](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Remote JSON config](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`

### Planned features

- [Progress tracking](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Discussion forums](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Timetable generator](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`
- [Career guidance](https://github.com/nyikomnisii/studymate/blob/main/README.md): `README.md`

### Other components

- **Grade 12 student**

## Connections

- Grade 12 student → StudyMate app: uses (evidence: `README.md`)
- StudyMate app → Subject navigation: offers navigation (evidence: `README.md`)
- StudyMate app → PDF study materials: provides PDFs (evidence: `README.md`)
- StudyMate app → Firebase authentication: uses authentication (evidence: `README.md`)
- StudyMate app → Firebase realtime database: uses database (evidence: `README.md`)
- StudyMate app → OneSignal notifications: integrates notifications (evidence: `README.md`)
- StudyMate app → AdMob ads: shows ads (evidence: `README.md`)
- StudyMate app → Remote JSON config: fetches configuration (evidence: `README.md`)
- StudyMate app → Progress tracking: plans tracking (evidence: `README.md`)
- StudyMate app → Discussion forums: plans forums (evidence: `README.md`)
- StudyMate app → Timetable generator: plans generation (evidence: `README.md`)
- StudyMate app → Career guidance: plans guidance (evidence: `README.md`)
