# readyouapp/readyou architecture

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

- Interactive diagram: https://gitdiagram.com/readyouapp/readyou
- Repository: https://github.com/readyouapp/readyou

## Overview

##### Project type and purpose
- This is a single-module Android application (“app”) written in Kotlin using Jetpack Compose for UI.
- It is an RSS reader (“Read You”) that synchronizes with various RSS back-end services (Fever, Google Reader, FreshRSS, etc.), stores data locally, presents feeds and articles in Material You style, and supports background workers and notifications.

##### File structure
- Top-level “app” module contains:
- schemas/ – database schema snapshots (Room)
- src/main/java/me/ash/reader/domain – core use-cases, models, repository interfaces
- src/main/java/me/ash/reader/infrastructure – concrete implementations: Android framework, network, database, DataStore, DI modules, exception handling, HTML parsing
- src/main/java/me/ash/reader/ui – Compose components, pages, view models, theming, widgets
- build.gradle.kts, proguard rules – build and packaging
- Tests under src/test and src/androidTest
- CI/CD via GitHub Actions and Fastlane for releases

##### Extract insights from README
- Confirms Material You/Jetpack Compose stack
- Lists supported integrations, features (OPML import/export, read-aloud, notifications)
- Mentions use of open-source libraries (Retrofit, OkHttp, Room, Readability4J)
- Encourages nightly builds via GitHub Actions

##### Main components
a. Presentation Layer (Android App)
- Activities/EntryPoints (MainActivity, CrashReportActivity)
- Compose pages and Components (UI/Page/ViewModel sub-packages)
- Widgets (App Widgets with WidgetConfig, ArticleCardWidget)
- NotificationHelper, TextToSpeech, CrashHandler
- AndroidImageDownloader, AndroidStringsHelper
b. Domain Layer
- Use Cases (ArticlePagingListUseCase, FilterStateUseCase, GroupWithFeedsListUseCase…)
- Domain Models (Article, Feed, Account, Group…)
- Repository interfaces (ArticleDao, FeedDao, AccountDao…)
- Domain services (SyncWorker, ReaderWorker, WidgetUpdateWorker)
c. Data / Infrastructure Layer
- Database (Room via AndroidDatabase, RYDatabase)
- Network (RetrofitModule, OkHttpClientModule, NetworkDataSource, API result wrappers)
- RSS providers (FeverAPI, GoogleReaderAPI, FreshRSS…)
- DataStore preferences (SettingsProvider, PreferenceExt)
- OPML parser, Readability parser
- DI (AccountServiceModule, DatabaseModule, UseCaseModule, WorkerModule…)
d. External services
- Third-party RSS back-ends (Fever, Google Reader, FreshRSS)
- OPML import/export
- F-Droid / GitHub Releases (CI/CD)

##### Relationships and data flow
- UI Layer ← calls → ViewModels
- ViewModels ← invoke → Domain Use Cases
- Use Cases ← dependent on → Repository interfaces
- Repository interfaces ← bound by DI to → Data Layer implementations
- Data Layer
- Database DAO ←→ Room DB (local storage)
- NetworkDataSource ←→ Retrofit/OkHttp ←→ External RSS APIs
- DataStore ←→ Settings storage
- Workers (WorkManager) scheduled to run SyncWorker / ReaderWorker / WidgetUpdateWorker
- Notifications / Widgets updated by background workers

##### Architectural patterns and design principles
- Clean-architecture layering: Presentation → Domain → Data
- Dependency Injection: manual DI modules instead of Hilt/Koin
- MVVM with Compose: ViewModels drive UI state
- Repository pattern for abstracting data sources
- Single Source of Truth: Room + DataStore
- Background processing via WorkManager

##### Technologies and frameworks to annotate
- Jetpack Compose (UI)
- Room (androidx.room)
- Retrofit + OkHttp (network)
- DataStore (androidx.datastore)
- WorkManager (androidx.work)
- Kotlin coroutines
- Gradle Kotlin DSL
- Fastlane + GitHub Actions (CI/CD)

##### Detail without overcomplicating
- Major packages and modules
- How DI wires interfaces to implementations
- Background tasks and notification updates

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Android App"
        subgraph "Presentation Layer"
            direction TB
            MA["MainActivity"]:::presentation
            CRA["CrashReportActivity"]:::presentation
            UI["UI Components"]:::presentation
            WID["Widgets"]:::presentation
            NP["NotificationHelper"]:::presentation
            TTS["TextToSpeech"]:::presentation
            CH["CrashHandler"]:::presentation
            AID["AndroidImageDownloader"]:::presentation
            ASH["AndroidStringsHelper"]:::presentation
            PVM["Pages & ViewModels"]:::presentation
        end

        %% Domain Layer
        subgraph "Domain Layer"
            direction TB
            UC["Use Cases"]:::domain
            DM["Models"]:::domain
            RI["Repository Interfaces"]:::domain
            SW["SyncWorker"]:::domain
            RW["ReaderWorker"]:::domain
            WW["WidgetUpdateWorker"]:::domain
        end

        %% Data / Infrastructure Layer
        subgraph "Data / Infrastructure Layer"
            direction TB
            DB["AndroidDatabase\n(Room)"]:::data
            SCH["DB Schemas"]:::data
            NDS["NetworkDataSource"]:::data
            RM["RetrofitModule"]:::data
            OM["OkHttpClientModule"]:::data
            FAPI["FeverAPI"]:::data
            GAPI["GoogleReaderAPI"]:::data
            ODS["OPMLDataSource"]:::data
            RDP["Readability"]:::data
            RYG["RYArticleGrabberExtended"]:::data
            PRE["PreferenceExt"]:::data
            SPM["SettingsProviderModule"]:::data
            DI["DI Modules"]:::data
        end
    end

    %% External Services
    subgraph "External Services"
        direction TB
        Fever["Fever RSS"]:::external
        GReader["Google Reader RSS"]:::external
        FRSS["FreshRSS"]:::external
        OPML["OPML Import/Export"]:::external
        CICD["CI/CD (GitHub Actions\n& Fastlane)"]:::external
    end

    %% Connections: Presentation -> Domain -> Data -> External
    MA -->|launches| PVM
    CRA -->|error reports| CH
    PVM -->|calls| UC
    NP -->|sends| NP
    PVM -->|uses| NP
    PVM -->|uses| TTS
    PVM -->|displays| UI
    UI -->|fetches| PVM
    WID -->|requests update| WW

    UC -->|invoke| RI
    UC -->|operate on| DM
    RI -->|implemented by| DB
    RI -->|implemented by| NDS
    RI -->|implemented by| ODS
    SW -->|syncs| NDS
    SW -->|writes| DB
    RW -->|reads| DB
    RW -->|parses| RDP
    WW -->|updates| WID
    WW -->|schedules| NP

    NDS -->|HTTP| FAPI
    NDS -->|HTTP| GAPI
    NDS -->|HTTP| FRSS
    ODS -->|reads/writes| OPML
    DI -->|binds| RI
    DI -->|provides| UC
    DI -->|configures| DB
    DI -->|configures| RM
    DI -->|configures| OM
    RM -->|builds client| NDS
    OM -->|builds| RM
    DB -->|schema| SCH
    PRE -->|stores| DB
    PRE -->|reads| SPM

    CICD -->|deploys| Fever
    CICD -->|deploys| GReader
    CICD -->|deploys| FRSS

    %% Click Events
    click MA "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/MainActivity.kt"
    click CRA "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/CrashReportActivity.kt"
    click NP "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/NotificationHelper.kt"
    click TTS "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/TextToSpeech.kt"
    click CH "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/CrashHandler.kt"
    click AID "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/AndroidImageDownloader.kt"
    click ASH "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/android/AndroidStringsHelper.kt"
    click UI "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/ui"
    click WID "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/ui/widget"
    click PVM "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/ui/page"
    click UC "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/domain/data"
    click DM "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/domain/model"
    click RI "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/domain/repository"
    click SW "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/domain/service/SyncWorker.kt"
    click RW "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/domain/service/ReaderWorker.kt"
    click WW "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/domain/service/WidgetUpdateWorker.kt"
    click DB "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/db/AndroidDatabase.kt"
    click SCH "https://github.com/readyouapp/readyou/blob/main/app/schemas/me.ash.reader.infrastructure.db.AndroidDatabase"
    click NDS "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/net/NetworkDataSource.kt"
    click RM "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/di/RetrofitModule.kt"
    click OM "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/di/OkHttpClientModule.kt"
    click FAPI "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/rss/provider/fever/FeverAPI.kt"
    click GAPI "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/rss/provider/greader/GoogleReaderAPI.kt"
    click ODS "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/rss/OPMLDataSource.kt"
    click RDP "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/html/Readability.kt"
    click RYG "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/html/RYArticleGrabberExtended.kt"
    click PRE "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/datastore/PreferenceExt.kt"
    click SPM "https://github.com/readyouapp/readyou/blob/main/app/src/main/java/me/ash/reader/infrastructure/di/SettingsProviderModule.kt"
    click DI "https://github.com/readyouapp/readyou/tree/main/app/src/main/java/me/ash/reader/infrastructure/di"

    %% Styles
    classDef presentation fill:#cce5ff,stroke:#004085,color:#004085;
    classDef domain fill:#d4edda,stroke:#155724,color:#155724;
    classDef data fill:#ffe5b4,stroke:#e69500,color:#e69500;
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
```
