# fchfaz/inka architecture

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

- Interactive diagram: https://gitdiagram.com/fchfaz/inka
- Repository: https://github.com/fchfaz/inka

## Overview

Inka is an offline-first Japanese flashcard PWA. The main workflow is selecting a deck, studying cards from a daily queue, answering through FSRS scheduling, and saving progress locally; deck management, imports/backups, settings, and statistics are supporting product branches. The graph uses the supplied excerpts, SOURCE INDEX references, and README claims; some feature-level wiring is documented but not directly shown in sampled code.

Main entry points: [`src/App.tsx`](https://github.com/fchfaz/inka/blob/master/src/App.tsx) (App Shell), [`src/pages/Study.tsx`](https://github.com/fchfaz/inka/blob/master/src/pages/Study.tsx) (Study Session), [`src/services/database.ts`](https://github.com/fchfaz/inka/blob/master/src/services/database.ts) (IndexedDB), [`src/services/anki/importer.ts`](https://github.com/fchfaz/inka/blob/master/src/services/anki/importer.ts) (Anki Importer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application"]
  node_app["App Shell<br/>[App.tsx]"]
  node_language["Language Context"]
  node_translations["Translation Catalogs<br/>[i18n.ts]"]
  node_messages["Feature Messages<br/>[messages.ts]"]
end

subgraph group_study["Study Workflow"]
  node_study["Study Session<br/>[Study.tsx]"]
  node_queue["Daily Queue<br/>[queue.ts]"]
  node_scheduler["FSRS Scheduler<br/>[srs.ts]"]
  node_flashcard["Card Display<br/>[Flashcard.tsx]"]
  node_answer["Review Controls<br/>[ReviewButtons.tsx]"]
  node_tts["Japanese Speech<br/>[tts.ts]"]
  node_sfx["Sound Effects<br/>[sfx.ts]"]
end

subgraph group_decks["Decks and Imports"]
  node_decks["Deck Manager<br/>[DeckManager.tsx]"]
  node_anki_dialog["Anki Import UI"]
  node_anki_reader["Anki Package Reader<br/>[apkg.ts]"]
  node_anki_convert["Anki Converter<br/>[convert.ts]"]
  node_anki_import["Anki Importer<br/>[importer.ts]"]
  node_exchange["Import and Backup<br/>[importExport.ts]"]
end

subgraph group_data["Local Data"]
  node_database[("IndexedDB<br/>[database.ts]")]
  node_media["Media Store<br/>[media.ts]"]
  node_richtext["Rich Text Safety<br/>[richText.ts]"]
end

subgraph group_insights["Settings and Insights"]
  node_settings["Settings<br/>[Settings.tsx]"]
  node_reminders["Backup Reminder<br/>[backupReminder.ts]"]
  node_statistics["Statistics<br/>[Statistics.tsx]"]
  node_stats_service["Stats Aggregation<br/>[stats.ts]"]
  node_charts["Statistics Charts"]
end

node_user(("Learner"))
node_speech_api["Browser Speech API"]

node_user -->|"opens"| node_app
node_app -->|"routes to"| node_study
node_app -->|"routes to"| node_decks
node_app -->|"routes to"| node_statistics
node_app -->|"routes to"| node_settings
node_app -->|"initializes"| node_database
node_app -->|"provides"| node_language
node_language -->|"reads"| node_translations
node_study -->|"loads queue"| node_queue
node_study -->|"schedules answers"| node_scheduler
node_study -->|"reads and saves"| node_database
node_study -->|"renders"| node_flashcard
node_study -->|"renders"| node_answer
node_study -->|"speaks cards"| node_tts
node_answer -->|"plays sounds"| node_sfx
node_tts -.->|"uses"| node_speech_api
node_decks -->|"reads and saves"| node_database
node_decks -->|"imports bundles"| node_exchange
node_decks -->|"opens"| node_anki_dialog
node_anki_dialog -->|"reads packages"| node_anki_reader
node_anki_dialog -->|"converts notes"| node_anki_convert
node_anki_dialog -->|"starts import"| node_anki_import
node_anki_import -->|"writes cards"| node_database
node_anki_import -->|"stores media"| node_media
node_anki_import -->|"converts fields"| node_richtext
node_anki_import -->|"uses package data"| node_anki_reader
node_anki_import -->|"converts notes"| node_anki_convert
node_exchange -->|"reads and writes"| node_database
node_exchange -->|"prunes media"| node_media
node_settings -->|"loads and saves"| node_database
node_settings -->|"backs up data"| node_exchange
node_settings -->|"manages media"| node_media
node_settings -->|"checks reminders"| node_reminders
node_statistics -->|"requests summaries"| node_stats_service
node_statistics -->|"reads records"| node_database
node_statistics -->|"renders charts"| node_charts
node_stats_service -->|"reads history"| node_database
node_stats_service -->|"uses queue data"| node_queue
node_flashcard -->|"renders content"| node_richtext
node_flashcard -->|"requests speech"| node_tts
node_richtext -->|"resolves tokens"| node_media

click node_app "https://github.com/fchfaz/inka/blob/master/src/App.tsx"
click node_study "https://github.com/fchfaz/inka/blob/master/src/pages/Study.tsx"
click node_queue "https://github.com/fchfaz/inka/blob/master/src/services/queue.ts"
click node_scheduler "https://github.com/fchfaz/inka/blob/master/src/services/srs.ts"
click node_flashcard "https://github.com/fchfaz/inka/blob/master/src/components/Flashcard.tsx"
click node_answer "https://github.com/fchfaz/inka/blob/master/src/components/ReviewButtons.tsx"
click node_tts "https://github.com/fchfaz/inka/blob/master/src/services/tts.ts"
click node_sfx "https://github.com/fchfaz/inka/blob/master/src/services/sfx.ts"
click node_decks "https://github.com/fchfaz/inka/blob/master/src/pages/DeckManager.tsx"
click node_anki_dialog "https://github.com/fchfaz/inka/blob/master/src/components/AnkiImportDialog.tsx"
click node_anki_reader "https://github.com/fchfaz/inka/blob/master/src/services/anki/apkg.ts"
click node_anki_convert "https://github.com/fchfaz/inka/blob/master/src/services/anki/convert.ts"
click node_anki_import "https://github.com/fchfaz/inka/blob/master/src/services/anki/importer.ts"
click node_exchange "https://github.com/fchfaz/inka/blob/master/src/services/importExport.ts"
click node_database "https://github.com/fchfaz/inka/blob/master/src/services/database.ts"
click node_media "https://github.com/fchfaz/inka/blob/master/src/services/media.ts"
click node_richtext "https://github.com/fchfaz/inka/blob/master/src/services/richText.ts"
click node_settings "https://github.com/fchfaz/inka/blob/master/src/pages/Settings.tsx"
click node_reminders "https://github.com/fchfaz/inka/blob/master/src/services/backupReminder.ts"
click node_statistics "https://github.com/fchfaz/inka/blob/master/src/pages/Statistics.tsx"
click node_stats_service "https://github.com/fchfaz/inka/blob/master/src/services/stats.ts"
click node_charts "https://github.com/fchfaz/inka/blob/master/src/components/stats/HeatmapCalendar.tsx"
click node_language "https://github.com/fchfaz/inka/blob/master/src/context/LanguageContext.tsx"
click node_translations "https://github.com/fchfaz/inka/blob/master/src/services/i18n.ts"
click node_messages "https://github.com/fchfaz/inka/blob/master/src/services/messages.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_app,node_language,node_translations,node_messages,node_speech_api toneBlue
class node_study,node_queue,node_scheduler,node_flashcard,node_answer,node_tts,node_sfx toneAmber
class node_decks,node_anki_dialog,node_anki_reader,node_anki_convert,node_anki_import,node_exchange toneMint
class node_database,node_media,node_richtext toneRose
class node_settings,node_reminders,node_statistics,node_stats_service,node_charts,node_user toneIndigo
```

## Components

### Application

- [App Shell](https://github.com/fchfaz/inka/blob/master/src/App.tsx): `src/App.tsx`
- [Language Context](https://github.com/fchfaz/inka/blob/master/src/context/LanguageContext.tsx): `src/context/LanguageContext.tsx`
- [Translation Catalogs](https://github.com/fchfaz/inka/blob/master/src/services/i18n.ts): `src/services/i18n.ts`
- [Feature Messages](https://github.com/fchfaz/inka/blob/master/src/services/messages.ts): `src/services/messages.ts`

### Study Workflow

- [Study Session](https://github.com/fchfaz/inka/blob/master/src/pages/Study.tsx): `src/pages/Study.tsx`
- [Daily Queue](https://github.com/fchfaz/inka/blob/master/src/services/queue.ts): `src/services/queue.ts`
- [FSRS Scheduler](https://github.com/fchfaz/inka/blob/master/src/services/srs.ts): `src/services/srs.ts`
- [Card Display](https://github.com/fchfaz/inka/blob/master/src/components/Flashcard.tsx): `src/components/Flashcard.tsx`
- [Review Controls](https://github.com/fchfaz/inka/blob/master/src/components/ReviewButtons.tsx): `src/components/ReviewButtons.tsx`
- [Japanese Speech](https://github.com/fchfaz/inka/blob/master/src/services/tts.ts): `src/services/tts.ts`
- [Sound Effects](https://github.com/fchfaz/inka/blob/master/src/services/sfx.ts): `src/services/sfx.ts`

### Decks and Imports

- [Deck Manager](https://github.com/fchfaz/inka/blob/master/src/pages/DeckManager.tsx): `src/pages/DeckManager.tsx`
- [Anki Import UI](https://github.com/fchfaz/inka/blob/master/src/components/AnkiImportDialog.tsx): `src/components/AnkiImportDialog.tsx`
- [Anki Package Reader](https://github.com/fchfaz/inka/blob/master/src/services/anki/apkg.ts): `src/services/anki/apkg.ts`
- [Anki Converter](https://github.com/fchfaz/inka/blob/master/src/services/anki/convert.ts): `src/services/anki/convert.ts`
- [Anki Importer](https://github.com/fchfaz/inka/blob/master/src/services/anki/importer.ts): `src/services/anki/importer.ts`
- [Import and Backup](https://github.com/fchfaz/inka/blob/master/src/services/importExport.ts): `src/services/importExport.ts`

### Local Data

- [IndexedDB](https://github.com/fchfaz/inka/blob/master/src/services/database.ts): `src/services/database.ts`
- [Media Store](https://github.com/fchfaz/inka/blob/master/src/services/media.ts): `src/services/media.ts`
- [Rich Text Safety](https://github.com/fchfaz/inka/blob/master/src/services/richText.ts): `src/services/richText.ts`

### Settings and Insights

- [Settings](https://github.com/fchfaz/inka/blob/master/src/pages/Settings.tsx): `src/pages/Settings.tsx`
- [Backup Reminder](https://github.com/fchfaz/inka/blob/master/src/services/backupReminder.ts): `src/services/backupReminder.ts`
- [Statistics](https://github.com/fchfaz/inka/blob/master/src/pages/Statistics.tsx): `src/pages/Statistics.tsx`
- [Stats Aggregation](https://github.com/fchfaz/inka/blob/master/src/services/stats.ts): `src/services/stats.ts`
- [Statistics Charts](https://github.com/fchfaz/inka/blob/master/src/components/stats/HeatmapCalendar.tsx): `src/components/stats/HeatmapCalendar.tsx`

### Other components

- **Learner**
- **Browser Speech API**

## Connections

- Learner → App Shell: opens (evidence: `README.md`)
- App Shell → Study Session: routes to (evidence: `src/App.tsx`)
- App Shell → Deck Manager: routes to (evidence: `src/App.tsx`)
- App Shell → Statistics: routes to (evidence: `src/App.tsx`)
- App Shell → Settings: routes to (evidence: `src/App.tsx`)
- App Shell → IndexedDB: initializes (evidence: `src/App.tsx`)
- App Shell → Language Context: provides (evidence: `src/App.tsx`)
- Language Context → Translation Catalogs: reads (evidence: `src/context/LanguageContext.tsx`)
- Study Session → Daily Queue: loads queue (evidence: `src/pages/Study.tsx`)
- Study Session → FSRS Scheduler: schedules answers (evidence: `src/pages/Study.tsx`)
- Study Session → IndexedDB: reads and saves (evidence: `src/pages/Study.tsx`)
- Study Session → Card Display: renders (evidence: `src/pages/Study.tsx`)
- Study Session → Review Controls: renders (evidence: `src/pages/Study.tsx`)
- Study Session → Japanese Speech: speaks cards (evidence: `src/pages/Study.tsx`)
- Review Controls → Sound Effects: plays sounds (evidence: `src/components/ReviewButtons.tsx`)
- Japanese Speech → Browser Speech API: uses (evidence: `README.md`)
- Deck Manager → IndexedDB: reads and saves (evidence: `src/pages/DeckManager.tsx`)
- Deck Manager → Import and Backup: imports bundles (evidence: `src/pages/DeckManager.tsx`)
- Deck Manager → Anki Import UI: opens (evidence: `src/pages/DeckManager.tsx`)
- Anki Import UI → Anki Package Reader: reads packages (evidence: `src/components/AnkiImportDialog.tsx`)
- Anki Import UI → Anki Converter: converts notes (evidence: `src/components/AnkiImportDialog.tsx`)
- Anki Import UI → Anki Importer: starts import (evidence: `src/components/AnkiImportDialog.tsx`)
- Anki Importer → IndexedDB: writes cards (evidence: `src/services/anki/importer.ts`)
- Anki Importer → Media Store: stores media (evidence: `src/services/anki/importer.ts`)
- Anki Importer → Rich Text Safety: converts fields (evidence: `src/services/anki/importer.ts`)
- Anki Importer → Anki Package Reader: uses package data (evidence: `src/services/anki/importer.ts`)
- Anki Importer → Anki Converter: converts notes (evidence: `src/services/anki/importer.ts`)
- Import and Backup → IndexedDB: reads and writes (evidence: `src/services/importExport.ts`)
- Import and Backup → Media Store: prunes media (evidence: `src/services/importExport.ts`)
- Settings → IndexedDB: loads and saves (evidence: `src/pages/Settings.tsx`)
- Settings → Import and Backup: backs up data (evidence: `src/pages/Settings.tsx`)
- Settings → Media Store: manages media (evidence: `src/pages/Settings.tsx`)
- Settings → Backup Reminder: checks reminders (evidence: `src/pages/Settings.tsx`)
- Statistics → Stats Aggregation: requests summaries (evidence: `src/pages/Statistics.tsx`)
- Statistics → IndexedDB: reads records (evidence: `src/pages/Statistics.tsx`)
- Statistics → Statistics Charts: renders charts (evidence: `src/pages/Statistics.tsx`)
- Stats Aggregation → IndexedDB: reads history (evidence: `src/services/stats.ts`)
- Stats Aggregation → Daily Queue: uses queue data (evidence: `src/services/stats.ts`)
- Card Display → Rich Text Safety: renders content (evidence: `src/components/Flashcard.tsx`)
- Card Display → Japanese Speech: requests speech (evidence: `src/components/Flashcard.tsx`)
- Rich Text Safety → Media Store: resolves tokens (evidence: `src/components/RichText.tsx`)
