# feritiro/japanesedictionary-notification-androidstudio architecture

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

- Interactive diagram: https://gitdiagram.com/feritiro/japanesedictionary-notification-androidstudio
- Repository: https://github.com/feritiro/japanesedictionary-notification-androidstudio

## Overview

JP Notify passively presents JLPT kanji flashcards when the phone screen turns off. Users select JLPT levels in the app; the screen-off receiver delegates notification creation, which reads those preferences, fetches a random matching entry from the bundled offline SQLite database, and posts a custom-layout notification. The sampled source shows this main path and an unlock receiver that can reopen the app. Other UI fragments are navigation scaffolding. The manifest and unsampled resources were not inspected, so platform wiring beyond the documented and excerpted calls is omitted.

Main entry points: [`app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt) (Notification builder), [`app/src/main/java/com/itiro/jp_notify/MainActivity.kt`](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/MainActivity.kt) (Settings activity), [`app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt`](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt) (Screen-off receiver), [`app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt`](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt) (Kanji database helper)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_settings["Level settings"]
  node_activity["Settings activity<br/>[MainActivity.kt]"]
  node_preferences[("Level preferences")]
end

subgraph group_flashcards["Flashcard delivery"]
  node_receiver["Screen-off receiver"]
  node_notification["Notification builder"]
  node_layout["Custom flashcard layout"]
  node_unlock_receiver["Unlock receiver<br/>[UnlockReceiver.kt]"]
end

subgraph group_content["Kanji content"]
  node_database_helper["Kanji database helper"]
  node_kanji_database[("Bundled JLPT database<br/>[jlpt_words.sqlite]")]
end

node_user(("App user"))
node_screen(("Screen-off event"))
node_android_notifications["Android notifications"]

node_user -->|"selects levels"| node_activity
node_activity -->|"registers"| node_receiver
node_activity -->|"writes levels"| node_preferences
node_screen -->|"broadcasts"| node_receiver
node_receiver -->|"requests notification"| node_notification
node_notification -->|"reads levels"| node_preferences
node_notification -->|"queries kanji"| node_database_helper
node_database_helper -->|"copies and queries"| node_kanji_database
node_notification -->|"sets flashcard text"| node_layout
node_notification -->|"posts notification"| node_android_notifications
node_user -.->|"unlocks phone"| node_unlock_receiver

click node_activity "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/MainActivity.kt"
click node_receiver "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt"
click node_notification "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt"
click node_layout "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/res/layout/notification_custom.xml"
click node_database_helper "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt"
click node_kanji_database "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/assets/jlpt_words.sqlite"
click node_unlock_receiver "https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/UnlockReceiver.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_activity,node_preferences,node_user,node_screen toneBlue
class node_receiver,node_notification,node_layout,node_unlock_receiver toneAmber
class node_database_helper,node_kanji_database toneMint
class node_android_notifications toneIndigo
```

## Components

### Level settings

- [Settings activity](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/MainActivity.kt): `app/src/main/java/com/itiro/jp_notify/MainActivity.kt`
- **Level preferences**

### Flashcard delivery

- [Screen-off receiver](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt): `app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt`
- [Notification builder](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt): `app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`
- [Custom flashcard layout](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/res/layout/notification_custom.xml): `app/src/main/res/layout/notification_custom.xml`
- [Unlock receiver](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/UnlockReceiver.kt): `app/src/main/java/com/itiro/jp_notify/UnlockReceiver.kt`

### Kanji content

- [Kanji database helper](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt): `app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt`
- [Bundled JLPT database](https://github.com/feritiro/japanesedictionary-notification-androidstudio/blob/master/app/src/main/assets/jlpt_words.sqlite): `app/src/main/assets/jlpt_words.sqlite`

### Other components

- **App user**
- **Screen-off event**
- **Android notifications**

## Connections

- App user → Settings activity: selects levels (evidence: `app/src/main/java/com/itiro/jp_notify/MainActivity.kt`)
- Settings activity → Screen-off receiver: registers (evidence: `app/src/main/java/com/itiro/jp_notify/MainActivity.kt`)
- Settings activity → Level preferences: writes levels (evidence: `app/src/main/java/com/itiro/jp_notify/MainActivity.kt`)
- Screen-off event → Screen-off receiver: broadcasts (evidence: `README.md`)
- Screen-off receiver → Notification builder: requests notification (evidence: `app/src/main/java/com/itiro/jp_notify/ScreenOffReceiver.kt`)
- Notification builder → Level preferences: reads levels (evidence: `app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`)
- Notification builder → Kanji database helper: queries kanji (evidence: `app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`)
- Kanji database helper → Bundled JLPT database: copies and queries (evidence: `app/src/main/java/com/itiro/jp_notify/KanjiDatabaseHelper.kt`)
- Notification builder → Custom flashcard layout: sets flashcard text (evidence: `app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`)
- Notification builder → Android notifications: posts notification (evidence: `app/src/main/java/com/itiro/jp_notify/NotificationUtils.kt`)
- App user → Unlock receiver: unlocks phone
