# tarik-b/pokechu architecture

> Architecture diagram of the GitHub repository tarik-b/pokechu, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tarik-b/pokechu
- Repository: https://github.com/tarik-b/pokechu

## Overview

##### Project type and purpose
- This is a two‐part system:
a) A Python‐based data parser/exporter that fetches and processes Pokémon data from Poképedia and PokéAPI and writes out a local SQLite DB, Kotlin enum files, XML string resources, and image assets.
b) An Android mobile app (Kotlin, MVVM, Room) that bundles those generated assets (db.sqlite, enums, XML, images) and presents a spoiler‐free Pokédex UI.

##### Main components
- Parser Service (Python)
– Input: external sources (Poképedia pages, PokéAPI REST endpoints)
– Process: parser.main → parsing modules → exporter modules
– Output: parser_output folder containing
- db.sqlite (SQLite database)
- Kotlin enum source files
- XML string resource files (localized values-en, values-fr)
- Downloaded image assets
- Artifact Storage
– File system folder (“parser_output/”) or CI storage for passing assets to Android build
- Android App (Kotlin, Gradle project “pokechu”)
– Build system: Gradle module “app”
– Assets:
- app/src/main/assets/db.sqlite
- app/src/main/res/values-*/ (XML resources)
- app/src/main/assets/images/*
– Data Layer:
- Room Database (Database.kt, Entities, DAOs)
- DataRepository classes (Pokemon, Regions, Evolutions, Preferences)
- Managers (SettingsManager, LocalizationManager)
– Domain Layer:
- ViewModel classes (ViewModelPokemonList, ViewModelDetails, etc.)
– Presentation Layer:
- UI Components: Activities, Fragments, RecyclerViews, Compose screens
- Utility classes (AssetUtils, UIUtils)
– External Libraries: GraphView, Localization, Leonids, LivePreferences, FastScroll, CollapsingAvatarToolbarSample

##### Relationships and data flows
- Parser Service → (exports) → Artifact Storage
- Artifact Storage → (ingested by) → Android Build & Packaging
- At runtime:
- UI Layer ← ViewModels ← Repositories ← Room DB (db.sqlite) & SharedPreferences
- UI Layer interacts with Managers for theme, localization, settings
- ViewModels expose LiveData/Flows to UI
- Configuration: Gradle build scripts orchestrate resource merging and asset bundling

##### Architectural patterns and design principles
- Parser: modular Python code (parsing vs. exporting), single‐responsibility modules
- Android app: MVVM pattern
- Separation of concerns:
– Data repositories handle raw data access
– ViewModels mediate between repositories and UI
– Activities/Fragments/Compose handle rendering and user interaction
- Dependency injection (via ApplicationExecutors or manual wiring)
- Room ORM for strongly‐typed database access
- Localization strategy: separate data language (XML resources) from app UI language

##### Detail capture
- Top‐level folder as a component in the parser (parser/parsing vs. parser/export)
- Configuration artifacts (build.gradle, settings.gradle) at the boundary between parser outputs and Android inputs
- Don’t overload with every individual file—focus on modules and their relationships

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Services
    Pokepedia["Poképedia Pages"]:::external
    PokeAPI["PokéAPI REST Endpoints"]:::external

    %% Parser Subsystem
    subgraph "Parser Service" 
        direction TB
        ParserMain["parser/main.py"]:::parser
        ParsingModules["parser/parsing/"]:::parser
        ExporterModules["parser/export/"]:::parser
        DataEnums["parser/data/data_enums.py"]:::parser
        Utils["parser/utils/utils.py"]:::parser
    end

    %% Parser Outputs
    subgraph "Artifact Storage (parser_output)" 
        direction TB
        DBFile["db.sqlite"]:::artifact
        KotlinEnums["*.kt (Enums)"]:::artifact
        XMLResources["values-*/ XML"]:::artifact
        Images["images/*"]:::artifact
    end

    %% Android App Build and Runtime
    subgraph "Android App (pokechu)" 
        direction TB

        %% Build Scripts
        subgraph "Configuration"
            BuildGradle["app/build.gradle"]:::config
            SettingsGradle["settings.gradle"]:::config
        end

        %% Build Time Assets
        subgraph "Build Time Assets" 
            direction TB
            AssetDB["db.sqlite (assets)"]:::asset
            AssetImages["images/* (assets)"]:::asset
            AssetXML["res/values-*/ XML"]:::asset
        end

        %% Runtime Layers
        subgraph "Runtime"
            direction TB

            subgraph "Data Layer"
                direction TB
                RoomDB["Database.kt"]:::data
                Entities["entities/"]:::data
                Joins["joins/"]:::data
                Repositories["DataRepository*.kt"]:::data
                Preferences["preferences/"]:::data
            end

            subgraph "Domain Layer"
                ViewModels["viewmodel/"]:::domain
            end

            subgraph "Presentation Layer"
                UI["ui/"]:::presentation
                UtilsUI["utils/"]:::presentation
            end

            subgraph "Managers"
                SettingsManager["SettingsManager.kt"]:::manager
                LocalizationManager["LocalizationManager.kt"]:::manager
            end

            subgraph "Enums"
                EnumsGen["enums/"]:::enum
            end

            subgraph "Application"
                Executors["ApplicationExecutors.kt"]:::app
                AppClass["PokechuApplication.kt"]:::app
            end

        end
    end

    %% Data Flows
    Pokepedia -->|"HTML data"| ParserMain
    PokeAPI -->|"JSON data"| ParserMain
    ParserMain --> ParsingModules
    ParsingModules --> DataEnums
    ParsingModules --> Utils
    ParsingModules --> ExporterModules
    ExporterModules --> DBFile
    ExporterModules --> KotlinEnums
    ExporterModules --> XMLResources
    ExporterModules --> Images

    %% Artifact handoff
    DBFile --> ArtifactStorage
    KotlinEnums --> ArtifactStorage
    XMLResources --> ArtifactStorage
    Images --> ArtifactStorage

    ArtifactStorage["Artifact Storage"]:::artifact -->|"bundled"| AssetDB
    ArtifactStorage -->|"bundled"| AssetImages
    ArtifactStorage -->|"bundled"| AssetXML

    %% Runtime dependencies
    AssetDB --> RoomDB
    RoomDB --> Entities
    Entities --> Joins
    RoomDB --> Repositories
    Preferences --> Repositories
    Repositories --> ViewModels
    ViewModels --> UI
    ViewModels --> UtilsUI
    UI --> SettingsManager
    UI --> LocalizationManager
    ViewModels --> SettingsManager
    ViewModels --> LocalizationManager
    KotlinEnums --> EnumsGen

    %% Click Events
    click ParserMain "https://github.com/tarik-b/pokechu/blob/main/parser/main.py"
    click ParsingModules "https://github.com/tarik-b/pokechu/tree/main/parser/parsing/"
    click ExporterModules "https://github.com/tarik-b/pokechu/tree/main/parser/export/"
    click DataEnums "https://github.com/tarik-b/pokechu/blob/main/parser/data/data_enums.py"
    click Utils "https://github.com/tarik-b/pokechu/blob/main/parser/utils/utils.py"
    click DBFile "https://github.com/tarik-b/pokechu/blob/main/parser_output/db.sqlite"
    click KotlinEnums "https://github.com/tarik-b/pokechu/tree/main/parser_output/"
    click XMLResources "https://github.com/tarik-b/pokechu/tree/main/parser_output/values-en/"
    click Images "https://github.com/tarik-b/pokechu/tree/main/parser_output/images/"
    click BuildGradle "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/build.gradle"
    click SettingsGradle "https://github.com/tarik-b/pokechu/blob/main/pokechu/settings.gradle"
    click AssetDB "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/assets/db.sqlite"
    click AssetImages "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/assets/images/"
    click AssetXML "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/res/values-*/"
    click RoomDB "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/java/fr/amazer/pokechu/database/Database.kt"
    click Entities "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/database/entities/"
    click Joins "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/database/joins/"
    click Repositories "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/data/"
    click Preferences "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/data/preferences/"
    click ViewModels "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/viewmodel/"
    click UI "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/ui/"
    click UtilsUI "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/utils/"
    click SettingsManager "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/java/fr/amazer/pokechu/managers/SettingsManager.kt"
    click LocalizationManager "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/java/fr/amazer/pokechu/managers/LocalizationManager.kt"
    click EnumsGen "https://github.com/tarik-b/pokechu/tree/main/pokechu/app/src/main/java/fr/amazer/pokechu/enums/"
    click Executors "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/java/fr/amazer/pokechu/ApplicationExecutors.kt"
    click AppClass "https://github.com/tarik-b/pokechu/blob/main/pokechu/app/src/main/java/fr/amazer/pokechu/PokechuApplication.kt"

    %% Styles
    classDef external fill:#dddddd,stroke:#555,stroke-width:1px
    classDef parser fill:#bbdefb,stroke:#1e88e5,stroke-width:2px
    classDef artifact fill:#c8e6c9,stroke:#388e3c,stroke-width:2px
    classDef config fill:#e0e0e0,stroke:#757575,stroke-width:1px
    classDef asset fill:#dcedc8,stroke:#558b2f,stroke-width:1px
    classDef data fill:#fff9c4,stroke:#fbc02d,stroke-width:2px
    classDef domain fill:#ffe0b2,stroke:#fb8c00,stroke-width:2px
    classDef presentation fill:#ffccbc,stroke:#e64a19,stroke-width:2px
    classDef manager fill:#f0f4c3,stroke:#afb42b,stroke-width:1px
    classDef enum fill:#e1bee7,stroke:#8e24aa,stroke-width:1px
    classDef app fill:#c5cae9,stroke:#3949ab,stroke-width:2px
```
