# tedmkr/journal-mobile architecture

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

## Overview

This is an Android academic journal app for administrators, teachers, methodists, and students. Users authenticate, enter role-specific navigation, and perform journal, learning, or administration tasks; feature modules access the backend through repositories and JournalApi, with Room-backed session/cache and queued journal edits supporting offline use. The tree documents broad role capabilities, but most feature implementations and repository wiring were not sampled, so their internal calls are omitted. The notification and sync worker relationships shown below are supported by excerpts.

Main entry points: [`app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`](https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/navigation/JournalNavHost.kt) (Role navigation), [`app/src/main/java/com/journal/app/MainActivity.kt`](https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/MainActivity.kt) (Android entry), [`features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt`](https://github.com/tedmkr/journal-mobile/blob/main/features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt) (Auth flow), [`core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt`](https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt) (Pending edit sync)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App shell"]
  node_shell["Android entry<br/>[MainActivity.kt]"]
  node_navigation["Role navigation<br/>[JournalNavHost.kt]"]
end

subgraph group_identity["Identity"]
  node_authui["Sign-in UI<br/>[AuthRoute.kt]"]
  node_authflow["Auth flow<br/>[AuthViewModel.kt]"]
  node_authrepo["Token exchange<br/>[AuthRepository.kt]"]
  node_session["Session state"]
  node_tokenstate["Token state<br/>[TokenSession.kt]"]
end

subgraph group_features["Role features"]
  node_admin["Admin tools"]
  node_teacher["Teacher journals"]
  node_methodist["Methodist planning"]
  node_student["Student portal"]
end

subgraph group_data["Data services"]
  node_repos["Domain repositories"]
  node_api["Journal API<br/>[JournalApi.kt]"]
  node_sync["Pending edit sync<br/>[SyncWorker.kt]"]
  node_grades["Grade notifications"]
end

subgraph group_storage["Local storage"]
  node_db[("Room database<br/>[JournalDatabase.kt]")]
  node_pending["Pending actions"]
  node_gridcache["Journal grid cache"]
  node_sessiondao["Session records<br/>[SessionDao.kt]"]
  node_subjectcache["Student subject cache"]
end

node_person(("App user"))
node_keycloak["Keycloak"]
node_backend["Journal backend"]
node_notifier["Android notifications"]

node_person -->|"opens"| node_shell
node_shell -->|"shows"| node_navigation
node_navigation -->|"routes to"| node_authui
node_authui -->|"delegates to"| node_authflow
node_authflow -->|"refreshes tokens"| node_authrepo
node_authrepo -->|"exchanges tokens"| node_keycloak
node_authflow -->|"saves session"| node_session
node_authflow -->|"sets tokens"| node_tokenstate
node_navigation -->|"routes by role"| node_admin
node_navigation -->|"routes by role"| node_teacher
node_navigation -->|"routes by role"| node_methodist
node_navigation -->|"routes by role"| node_student
node_repos -.->|"calls"| node_api
node_api -.->|"requests"| node_backend
node_shell -->|"enqueues"| node_sync
node_sync -->|"loads and updates"| node_pending
node_sync -->|"invalidates"| node_gridcache
node_sync -->|"dispatches edits"| node_api
node_shell -->|"enqueues for students"| node_grades
node_grades -->|"fetches subject cards"| node_api
node_grades -->|"reads and writes"| node_subjectcache
node_grades -->|"reports changes"| node_notifier
node_session -->|"reads and writes"| node_sessiondao
node_session -->|"clears tables"| node_db

click node_shell "https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/MainActivity.kt"
click node_navigation "https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/navigation/JournalNavHost.kt"
click node_authui "https://github.com/tedmkr/journal-mobile/blob/main/features/auth/src/main/java/com/journal/features/auth/AuthRoute.kt"
click node_authflow "https://github.com/tedmkr/journal-mobile/blob/main/features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt"
click node_authrepo "https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/repository/AuthRepository.kt"
click node_session "https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/repository/SessionRepository.kt"
click node_tokenstate "https://github.com/tedmkr/journal-mobile/blob/main/core/common/src/main/java/com/journal/core/common/config/TokenSession.kt"
click node_admin "https://github.com/tedmkr/journal-mobile/tree/main/features/admin"
click node_teacher "https://github.com/tedmkr/journal-mobile/tree/main/features/teacher"
click node_methodist "https://github.com/tedmkr/journal-mobile/tree/main/features/methodist"
click node_student "https://github.com/tedmkr/journal-mobile/tree/main/features/student"
click node_repos "https://github.com/tedmkr/journal-mobile/tree/main/core/data/src/main/java/com/journal/core/data/repository"
click node_api "https://github.com/tedmkr/journal-mobile/blob/main/core/network/src/main/java/com/journal/core/network/api/JournalApi.kt"
click node_sync "https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt"
click node_grades "https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt"
click node_db "https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/JournalDatabase.kt"
click node_pending "https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/PendingActionDao.kt"
click node_gridcache "https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/JournalGridCacheDao.kt"
click node_sessiondao "https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/SessionDao.kt"
click node_subjectcache "https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/StudentSubjectCardCacheDao.kt"

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_shell,node_navigation,node_person toneBlue
class node_authui,node_authflow,node_authrepo,node_session,node_tokenstate toneAmber
class node_admin,node_teacher,node_methodist,node_student toneMint
class node_repos,node_api,node_sync,node_grades toneRose
class node_db,node_pending,node_gridcache,node_sessiondao,node_subjectcache,node_keycloak,node_backend,node_notifier toneIndigo
```

## Components

### App shell

- [Android entry](https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/MainActivity.kt): `app/src/main/java/com/journal/app/MainActivity.kt`
- [Role navigation](https://github.com/tedmkr/journal-mobile/blob/main/app/src/main/java/com/journal/app/navigation/JournalNavHost.kt): `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`

### Identity

- [Sign-in UI](https://github.com/tedmkr/journal-mobile/blob/main/features/auth/src/main/java/com/journal/features/auth/AuthRoute.kt): `features/auth/src/main/java/com/journal/features/auth/AuthRoute.kt`
- [Auth flow](https://github.com/tedmkr/journal-mobile/blob/main/features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt): `features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt`
- [Token exchange](https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/repository/AuthRepository.kt): `core/data/src/main/java/com/journal/core/data/repository/AuthRepository.kt`
- [Session state](https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/repository/SessionRepository.kt): `core/data/src/main/java/com/journal/core/data/repository/SessionRepository.kt`
- [Token state](https://github.com/tedmkr/journal-mobile/blob/main/core/common/src/main/java/com/journal/core/common/config/TokenSession.kt): `core/common/src/main/java/com/journal/core/common/config/TokenSession.kt`

### Role features

- [Admin tools](https://github.com/tedmkr/journal-mobile/tree/main/features/admin): `features/admin`
- [Teacher journals](https://github.com/tedmkr/journal-mobile/tree/main/features/teacher): `features/teacher`
- [Methodist planning](https://github.com/tedmkr/journal-mobile/tree/main/features/methodist): `features/methodist`
- [Student portal](https://github.com/tedmkr/journal-mobile/tree/main/features/student): `features/student`

### Data services

- [Domain repositories](https://github.com/tedmkr/journal-mobile/tree/main/core/data/src/main/java/com/journal/core/data/repository): `core/data/src/main/java/com/journal/core/data/repository`
- [Journal API](https://github.com/tedmkr/journal-mobile/blob/main/core/network/src/main/java/com/journal/core/network/api/JournalApi.kt): `core/network/src/main/java/com/journal/core/network/api/JournalApi.kt`
- [Pending edit sync](https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt): `core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt`
- [Grade notifications](https://github.com/tedmkr/journal-mobile/blob/main/core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt): `core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt`

### Local storage

- [Room database](https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/JournalDatabase.kt): `core/database/src/main/java/com/journal/core/database/JournalDatabase.kt`
- [Pending actions](https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/PendingActionDao.kt): `core/database/src/main/java/com/journal/core/database/dao/PendingActionDao.kt`
- [Journal grid cache](https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/JournalGridCacheDao.kt): `core/database/src/main/java/com/journal/core/database/dao/JournalGridCacheDao.kt`
- [Session records](https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/SessionDao.kt): `core/database/src/main/java/com/journal/core/database/dao/SessionDao.kt`
- [Student subject cache](https://github.com/tedmkr/journal-mobile/blob/main/core/database/src/main/java/com/journal/core/database/dao/StudentSubjectCardCacheDao.kt): `core/database/src/main/java/com/journal/core/database/dao/StudentSubjectCardCacheDao.kt`

### Other components

- **App user**
- **Keycloak**
- **Journal backend**
- **Android notifications**

## Connections

- App user → Android entry: opens (evidence: `app/src/main/java/com/journal/app/MainActivity.kt`)
- Android entry → Role navigation: shows (evidence: `app/src/main/java/com/journal/app/MainActivity.kt`)
- Role navigation → Sign-in UI: routes to (evidence: `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`)
- Sign-in UI → Auth flow: delegates to (evidence: `features/auth/src/main/java/com/journal/features/auth/AuthRoute.kt`)
- Auth flow → Token exchange: refreshes tokens (evidence: `features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt`)
- Token exchange → Keycloak: exchanges tokens (evidence: `core/data/src/main/java/com/journal/core/data/repository/AuthRepository.kt`)
- Auth flow → Session state: saves session (evidence: `features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt`)
- Auth flow → Token state: sets tokens (evidence: `features/auth/src/main/java/com/journal/features/auth/AuthViewModel.kt`)
- Role navigation → Admin tools: routes by role (evidence: `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`)
- Role navigation → Teacher journals: routes by role (evidence: `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`)
- Role navigation → Methodist planning: routes by role (evidence: `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`)
- Role navigation → Student portal: routes by role (evidence: `app/src/main/java/com/journal/app/navigation/JournalNavHost.kt`)
- Domain repositories → Journal API: calls
- Journal API → Journal backend: requests
- Android entry → Pending edit sync: enqueues (evidence: `app/src/main/java/com/journal/app/MainActivity.kt`)
- Pending edit sync → Pending actions: loads and updates (evidence: `core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt`)
- Pending edit sync → Journal grid cache: invalidates (evidence: `core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt`)
- Pending edit sync → Journal API: dispatches edits (evidence: `core/data/src/main/java/com/journal/core/data/sync/SyncWorker.kt`)
- Android entry → Grade notifications: enqueues for students (evidence: `app/src/main/java/com/journal/app/MainActivity.kt`)
- Grade notifications → Journal API: fetches subject cards (evidence: `core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt`)
- Grade notifications → Student subject cache: reads and writes (evidence: `core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt`)
- Grade notifications → Android notifications: reports changes (evidence: `core/data/src/main/java/com/journal/core/data/notification/StudentGradeNotificationWorker.kt`)
- Session state → Session records: reads and writes (evidence: `core/data/src/main/java/com/journal/core/data/repository/SessionRepository.kt`)
- Session state → Room database: clears tables (evidence: `core/data/src/main/java/com/journal/core/data/repository/SessionRepository.kt`)
