# peteropal/mnemos architecture

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

## Overview

Mnemos is an Android flashcard learning app. Users organize material into categories and packs, create rich-text/image/LaTeX cards, then study them in free, rated, or SM-2 modes; ratings and schedules support review planning and progress statistics. The README documents Room/MVVM, task planning, Pomodoro, Google Sheets import, preferences, and onboarding. Most app implementation files were not sampled, so app relationships below are limited to documented capabilities. The sampled overflow-indicator library is shown as a separate reusable component; its use by the app is not established.

Main entry points: [`app/src/main/java/com/example/bc_praca_x/CardBuilderActivity.java`](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardBuilderActivity.java) (Card editor), [`app/src/main/java/com/example/bc_praca_x/CardPresenterFragment.java`](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardPresenterFragment.java) (Study modes), [`app/src/main/java/com/example/bc_praca_x/algorithm/SM2.java`](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SM2.java) (SM-2 scheduling), [`app/src/main/java/com/example/bc_praca_x/algorithm/SuccessRateCalculator.java`](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SuccessRateCalculator.java) (Success calculator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Study content"]
  node_categories["Categories"]
  node_packs["Card packs<br/>[AddCardPack.java]"]
  node_card_editor["Card editor"]
  node_rich_editor["Rich text editor<br/>[editor.html]"]
  node_formula_editor["Formula editor<br/>[FormulaEditor.java]"]
end

subgraph group_learning["Learning and review"]
  node_study_modes["Study modes"]
  node_sm2["SM-2 scheduling<br/>[SM2.java]"]
  node_success_rate["Success calculator"]
  node_tasks["Review tasks<br/>[TasksFragment.java]"]
  node_statistics["Statistics"]
end

subgraph group_appdata["Persistence and settings"]
  node_room[("Room database<br/>[DBHelper.java]")]
  node_repositories["Data repositories"]
  node_viewmodels["ViewModels"]
  node_preferences["User preferences"]
end

subgraph group_extras["Supporting features"]
  node_import["Sheets import"]
  node_pomodoro["Pomodoro timer<br/>[PomodoroTimer.java]"]
  node_tutorial["Onboarding tutorial"]
end

subgraph group_widget["Pager indicator library"]
  node_indicator["Pager indicator"]
  node_indicator_observer["Data observer"]
  node_snap_helper["Snap helper"]
end

node_learner(("Learner"))

node_learner -->|"organizes"| node_categories
node_learner -->|"organizes"| node_packs
node_learner -->|"creates cards"| node_card_editor
node_card_editor -->|"formats content"| node_rich_editor
node_card_editor -->|"adds formulas"| node_formula_editor
node_learner -->|"studies cards"| node_study_modes
node_study_modes -->|"rates for review"| node_sm2
node_study_modes -->|"records success"| node_success_rate
node_sm2 -->|"plans reviews"| node_tasks
node_learner -->|"checks schedule"| node_tasks
node_success_rate -->|"informs progress"| node_statistics
node_learner -->|"views progress"| node_statistics
node_viewmodels -->|"accesses data"| node_repositories
node_repositories -->|"persists records"| node_room
node_learner -->|"sets language and theme"| node_preferences
node_learner -->|"imports cards"| node_import
node_learner -->|"starts timer"| node_pomodoro
node_learner -->|"follows onboarding"| node_tutorial
node_indicator -->|"updates from"| node_indicator_observer
node_snap_helper -->|"notifies selection"| node_indicator

click node_categories "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/AddCategoryActivity.java"
click node_packs "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/AddCardPack.java"
click node_card_editor "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardBuilderActivity.java"
click node_rich_editor "https://github.com/peteropal/mnemos/blob/main/app/src/main/assets/editor.html"
click node_formula_editor "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/FormulaEditor.java"
click node_study_modes "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardPresenterFragment.java"
click node_sm2 "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SM2.java"
click node_success_rate "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SuccessRateCalculator.java"
click node_tasks "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/TasksFragment.java"
click node_statistics "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/StatisticsFragment.java"
click node_room "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/database/DBHelper.java"
click node_repositories "https://github.com/peteropal/mnemos/tree/main/app/src/main/java/com/example/bc_praca_x/database/repository"
click node_viewmodels "https://github.com/peteropal/mnemos/tree/main/app/src/main/java/com/example/bc_praca_x/database/viewmodel"
click node_preferences "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/UserSettingsManager.java"
click node_import "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/ImportFragment.java"
click node_pomodoro "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/helpers/PomodoroTimer.java"
click node_tutorial "https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/TutorialActivity.java"
click node_indicator "https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/OverflowPagerIndicator.kt"
click node_indicator_observer "https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/OverflowDataObserver.kt"
click node_snap_helper "https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/SimpleSnapHelper.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_categories,node_packs,node_card_editor,node_rich_editor,node_formula_editor toneBlue
class node_study_modes,node_sm2,node_success_rate,node_tasks,node_statistics toneAmber
class node_room,node_repositories,node_viewmodels,node_preferences toneMint
class node_import,node_pomodoro,node_tutorial toneRose
class node_indicator,node_indicator_observer,node_snap_helper,node_learner toneIndigo
```

## Components

### Study content

- [Categories](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/AddCategoryActivity.java): `app/src/main/java/com/example/bc_praca_x/AddCategoryActivity.java`
- [Card packs](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/AddCardPack.java): `app/src/main/java/com/example/bc_praca_x/AddCardPack.java`
- [Card editor](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardBuilderActivity.java): `app/src/main/java/com/example/bc_praca_x/CardBuilderActivity.java`
- [Rich text editor](https://github.com/peteropal/mnemos/blob/main/app/src/main/assets/editor.html): `app/src/main/assets/editor.html`
- [Formula editor](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/FormulaEditor.java): `app/src/main/java/com/example/bc_praca_x/FormulaEditor.java`

### Learning and review

- [Study modes](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/CardPresenterFragment.java): `app/src/main/java/com/example/bc_praca_x/CardPresenterFragment.java`
- [SM-2 scheduling](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SM2.java): `app/src/main/java/com/example/bc_praca_x/algorithm/SM2.java`
- [Success calculator](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/algorithm/SuccessRateCalculator.java): `app/src/main/java/com/example/bc_praca_x/algorithm/SuccessRateCalculator.java`
- [Review tasks](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/TasksFragment.java): `app/src/main/java/com/example/bc_praca_x/TasksFragment.java`
- [Statistics](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/StatisticsFragment.java): `app/src/main/java/com/example/bc_praca_x/StatisticsFragment.java`

### Persistence and settings

- [Room database](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/database/DBHelper.java): `app/src/main/java/com/example/bc_praca_x/database/DBHelper.java`
- [Data repositories](https://github.com/peteropal/mnemos/tree/main/app/src/main/java/com/example/bc_praca_x/database/repository): `app/src/main/java/com/example/bc_praca_x/database/repository`
- [ViewModels](https://github.com/peteropal/mnemos/tree/main/app/src/main/java/com/example/bc_praca_x/database/viewmodel): `app/src/main/java/com/example/bc_praca_x/database/viewmodel`
- [User preferences](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/UserSettingsManager.java): `app/src/main/java/com/example/bc_praca_x/UserSettingsManager.java`

### Supporting features

- [Sheets import](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/ImportFragment.java): `app/src/main/java/com/example/bc_praca_x/ImportFragment.java`
- [Pomodoro timer](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/helpers/PomodoroTimer.java): `app/src/main/java/com/example/bc_praca_x/helpers/PomodoroTimer.java`
- [Onboarding tutorial](https://github.com/peteropal/mnemos/blob/main/app/src/main/java/com/example/bc_praca_x/TutorialActivity.java): `app/src/main/java/com/example/bc_praca_x/TutorialActivity.java`

### Pager indicator library

- [Pager indicator](https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/OverflowPagerIndicator.kt): `overflow-library/src/main/java/cz/intik/overflowindicator/OverflowPagerIndicator.kt`
- [Data observer](https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/OverflowDataObserver.kt): `overflow-library/src/main/java/cz/intik/overflowindicator/OverflowDataObserver.kt`
- [Snap helper](https://github.com/peteropal/mnemos/blob/main/overflow-library/src/main/java/cz/intik/overflowindicator/SimpleSnapHelper.kt): `overflow-library/src/main/java/cz/intik/overflowindicator/SimpleSnapHelper.kt`

### Other components

- **Learner**

## Connections

- Learner → Categories: organizes (evidence: `README.md`)
- Learner → Card packs: organizes (evidence: `README.md`)
- Learner → Card editor: creates cards (evidence: `README.md`)
- Card editor → Rich text editor: formats content (evidence: `README.md`)
- Card editor → Formula editor: adds formulas (evidence: `README.md`)
- Learner → Study modes: studies cards (evidence: `README.md`)
- Study modes → SM-2 scheduling: rates for review (evidence: `README.md`)
- Study modes → Success calculator: records success (evidence: `README.md`)
- SM-2 scheduling → Review tasks: plans reviews (evidence: `README.md`)
- Learner → Review tasks: checks schedule (evidence: `README.md`)
- Success calculator → Statistics: informs progress (evidence: `README.md`)
- Learner → Statistics: views progress (evidence: `README.md`)
- ViewModels → Data repositories: accesses data (evidence: `README.md`)
- Data repositories → Room database: persists records (evidence: `README.md`)
- Learner → User preferences: sets language and theme (evidence: `README.md`)
- Learner → Sheets import: imports cards (evidence: `README.md`)
- Learner → Pomodoro timer: starts timer (evidence: `README.md`)
- Learner → Onboarding tutorial: follows onboarding (evidence: `README.md`)
- Pager indicator → Data observer: updates from (evidence: `overflow-library/src/main/java/cz/intik/overflowindicator/OverflowPagerIndicator.kt`)
- Snap helper → Pager indicator: notifies selection (evidence: `overflow-library/src/main/java/cz/intik/overflowindicator/SimpleSnapHelper.kt`)
