# doubtless46/doubtless-app architecture

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

- Interactive diagram: https://gitdiagram.com/doubtless46/doubtless-app
- Repository: https://github.com/doubtless46/doubtless-app

## Overview

##### Main Components
- User Interface (UI) & Presentation Layer:
- Activities & Fragments (e.g., MainActivity, LoginActivity, OnBoardingActivity, SplashActivity)
- Layout and theming resources (e.g., retro layouts, buttons, drawable resources)
- ViewModel & Use Cases (Domain/Presentation Logic):
- Individual ViewModels for each screen (e.g., DashboardViewModel, HomeViewModel, CreateDoubtViewModel)
- Use case classes organized under each screen’s directory that encapsulate business logic (e.g., PostDoubtUseCase, FetchHomeFeedUseCase, VotingUseCase)
- Navigation & Routing:
- Custom routing/navigation components (e.g., Router, FragNavigator, BackPressDispatcher)
- Manual bottom navigation management with multiple back stacks
- Dependency Management:
- Dependency Injection container (e.g., AppCompositionRoot in the di package) that glues components together
- Network & Data Communication:
- Network module (DoubtlessServer and related utilities) for API interactions
- Possibly local storage/sharing (e.g., DoubtDataSharedPrefUseCase) for persisting session or user data
- Analytics & Logging:
- AnalyticsTracker under the analytics package for user engagement tracking
- Utility & Theming:
- Utility functions and extensions (e.g., Utils, animations) and theming classes to support the retro UI

##### Relationships and Interactions
- The UI layer is at the top with Activities and Fragments communicating with their respective ViewModels.
- ViewModels call specific Use Cases that encapsulate business logic. These use cases handle tasks like posting doubts, fetching feeds, or managing user data.
- The Use Cases often interact with external components such as:
- The DoubtlessServer for network calls.
- Shared preferences or local databases for persistence.
- The DI container (AppCompositionRoot) is used to inject dependencies like the ViewModels, Use Cases, network services, and analytics components.
- The Navigation components are linked to the UI components to handle screen transitions and backstack management.
- AnalyticsTracker monitors user interactions across screens.

##### Architectural Patterns
- The project follows an MVVM-like structure with a clear separation between Views, ViewModels, and Use Cases.
- Dependency Injection is clearly used to centralize and manage dependencies within the app.
- There is an emphasis on modularization, with screens and their associated logic (use cases and view holders) segmented into their own packages.
- Custom UI navigation logic is implemented to support multiple back stacks while using a manual bottom navigation approach, showcasing a bespoke design pattern.

##### Technologies and Libraries of Note
- Android SDK as the base platform.
- Gradle used for project build and dependency management.
- Standard Android libraries for activities, fragments, and UI components.
- Custom-defined utilities and theming classes for the retro UI.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interface & Presentation Layer
    subgraph "User Interface"
        UI1["MainActivity"]:::ui
        UI2["LoginActivity"]:::ui
        UI3["OnBoardingActivity"]:::ui
        UI4["SplashActivity"]:::ui
        UI_L["Layout Resources"]:::ui
        UI_R["RetroLayout"]:::ui
    end

    %% ViewModel & Use Cases
    subgraph "ViewModel & Use Cases"
        VM1["DashboardViewModel"]:::logic
        VM2["HomeViewModel"]:::logic
        VM3["CreateDoubtViewModel"]:::logic
        VM4["AnswersViewModel"]:::logic
        VM5["ViewDoubtsViewModel"]:::logic
        subgraph "Use Cases"
            UC1["PostDoubtUseCase"]:::logic
            UC2["VotingUseCase"]:::logic
            UC3["FetchHomeFeedUseCase"]:::logic
            UC4["Answers Use Cases"]:::logic
            UC5["Other Use Cases"]:::logic
            UC6["DoubtDataSharedPrefUseCase"]:::logic
            UC7["UserDataStorageUseCase"]:::logic
        end
    end

    %% Navigation & Routing
    subgraph "Navigation & Routing"
        NAV1["Router"]:::nav
        NAV2["FragNavigator"]:::nav
        NAV3["BackPressDispatcher"]:::nav
    end

    %% Infrastructure
    subgraph "Infrastructure"
        INF1["DI Container"]:::infra
        INF2["DoubtlessServer"]:::infra
        INF3["AnalyticsTracker"]:::infra
        INF4["Local Data Storage"]:::infra
    end

    %% Utility & Theming
    subgraph "Utility & Theming"
        UTIL1["Utils"]:::util
        UTIL2["ViewAnimExtentions"]:::util
        UTIL3["Buttons (Primary/Secondary)"]:::util
        UTIL4["RetroBottomNavElementLayout"]:::util
    end

    %% Connections between layers
    %% UI to ViewModels
    UI1 -->|"userAction"| VM1
    UI2 -->|"userAction"| VM2
    UI3 -->|"userAction"| VM3
    UI4 -->|"userAction"| VM5

    %% UI to Navigation Components
    UI1 -->|"navigatesTo"| NAV1
    UI1 -->|"navigatesTo"| NAV2
    UI1 -->|"navigatesTo"| NAV3

    %% ViewModels to Use Cases
    VM1 -->|"calls"| UC1
    VM1 -->|"calls"| UC2
    VM2 -->|"calls"| UC3
    VM4 -->|"calls"| UC4
    VM5 -->|"calls"| UC5

    %% Use Cases to Network and Local Data
    UC1 -->|"networkCall"| INF2
    UC2 -->|"networkCall"| INF2
    UC3 -->|"networkCall"| INF2
    UC6 -->|"persists"| INF4
    UC7 -->|"persists"| INF4

    %% DI Container injection flows
    INF1 -->|"injects"| VM1
    INF1 -->|"injects"| VM2
    INF1 -->|"injects"| VM3
    INF1 -->|"injects"| VM4
    INF1 -->|"injects"| VM5
    INF1 -->|"injects"| UC1
    INF1 -->|"injects"| UC2
    INF1 -->|"injects"| UC3
    INF1 -->|"injects"| UC4
    INF1 -->|"injects"| UC5
    INF1 -->|"injects"| UC6
    INF1 -->|"injects"| UC7
    INF1 -->|"injects"| NAV1
    INF1 -->|"injects"| NAV2
    INF1 -->|"injects"| NAV3

    %% Use Cases logging to Analytics
    UC4 -->|"logs"| INF3
    UC5 -->|"logs"| INF3

    %% UI using Utility functions & theming
    UI1 -->|"uses"| UTIL1
    UI2 -->|"uses"| UTIL1
    UI1 -->|"animation"| UTIL2
    UI3 -->|"animation"| UTIL2
    UI_R -->|"styledBy"| UTIL3

    %% Navigation using themed elements
    NAV1 -->|"uses"| UTIL4

    %% Class Definitions for styling
    classDef ui fill:#CCEEFF,stroke:#036,stroke-width:2px;
    classDef logic fill:#E3F9E5,stroke:#0A3,stroke-width:2px;
    classDef nav fill:#FDEDD0,stroke:#D97600,stroke-width:2px;
    classDef infra fill:#FFE0CC,stroke:#D94C00,stroke-width:2px;
    classDef util fill:#FFF2CC,stroke:#D9A700,stroke-width:2px;

    %% Click Events for UI & Presentation Layer
    click UI1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/main/MainActivity.kt"
    click UI2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/auth/LoginActivity.kt"
    click UI3 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/onboarding/OnBoardingActivity.kt"
    click UI4 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/splash/SplashActivity.kt"
    click UI_L "https://github.com/doubtless46/doubtless-app/tree/master/app/src/main/res/layout/"
    click UI_R "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/theming/retro/RetroLayout.kt"

    %% Click Events for ViewModels
    click VM1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/dashboard/DashboardViewModel.kt"
    click VM2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/home/HomeViewModel.kt"
    click VM3 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/doubt/create/CreateDoubtViewModel.kt"
    click VM4 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/answers/AnswersViewModel.kt"
    click VM5 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/doubt/view/ViewDoubtsViewModel.kt"

    %% Click Events for Use Cases
    click UC1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/doubt/usecases/PostDoubtUseCase.kt"
    click UC2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/doubt/usecases/VotingUseCase.kt"
    click UC3 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/home/usecases/FetchHomeFeedUseCase.kt"
    click UC4 "https://github.com/doubtless46/doubtless-app/tree/master/app/src/main/java/com/doubtless/doubtless/screens/answers/usecases/"
    click UC6 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/doubt/usecases/DoubtDataSharedPrefUseCase.kt"
    click UC7 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/screens/auth/usecases/UserDataStorageUseCase.kt"

    %% Click Events for Navigation & Routing
    click NAV1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/navigation/Router.kt"
    click NAV2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/navigation/FragNavigator.kt"
    click NAV3 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/navigation/BackPressDispatcher.kt"

    %% Click Event for Dependency Injection
    click INF1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/di/AppCompositionRoot.kt"

    %% Click Events for Network & Data Communication
    click INF2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/network/DoubtlessServer.kt"

    %% Click Event for Analytics
    click INF3 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/analytics/AnalyticsTracker.kt"

    %% Click Events for Utility & Theming
    click UTIL1 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/utils/Utils.kt"
    click UTIL2 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/utils/anims/ViewAnimExtentions.kt"
    click UTIL3 "https://github.com/doubtless46/doubtless-app/tree/master/app/src/main/java/com/doubtless/doubtless/theming/buttons/"
    click UTIL4 "https://github.com/doubtless46/doubtless-app/blob/master/app/src/main/java/com/doubtless/doubtless/theming/buttons/RetroBottomNavElementLayout.kt"
```
