# chimple/crcontainer architecture

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

- Interactive diagram: https://gitdiagram.com/chimple/crcontainer
- Repository: https://github.com/chimple/crcontainer

## Overview

##### Project type and purpose
- CRcontainer is an Android full-stack client application (a “container” web browser) that runs on mobile. It displays web-based literacy content packaged by Curious Learning, persisting a manifest locally and fetching updates remotely.

##### Top-level architectural overview
- This is an Android MVVM-style architecture with the following layers:
- Presentation (Activities, Adapters, ViewModels)
- Domain/Business (WebAppRepository)
- Data (Local database via Room, Remote API via Retrofit)
- External services (Firebase, Install Referrer, Slack, etc.)
- Utilities (image loading, caching, deep-linking, config loading)

##### Main components
A. User Interface Layer (on the left)
– MainActivity & other BaseActivity subclasses
– WebAppActivity (hosts WebView)
– RecyclerView with WebAppsAdapter
– Language & settings pop-ups
B. Presentation/ViewModel Layer
– HomeViewModel (coordinates UI requests)
C. Repository/Domain Layer
– WebAppRepository (single source of truth)
D. Data Sources Layer
– Local Database (Room)
- WebAppDatabase
- WebAppDao
- Entities: WebApp, AppManifest
– Remote API (Retrofit)
- RetrofitInstance → ApiService → WebAppResponse
E. External Services & SDKs
– Firebase Analytics (AnalyticsUtils)
– Install Referrer (InstallReferrerManager)
– Slack notifications (SlackUtils)
F. Utilities & Helpers
– ConfigLoader (loads web_apps_manifest.json from assets)
– DeepLinkHelper (handles external URIs)
– CacheUtils, ImageLoader, AudioPlayer, etc.

##### Interactions and data flow
2. ViewModel → Repository: request list of WebApps
3. Repository checks Local DB (WebAppDao) → if stale or missing, calls Remote API (Retrofit)
4. RetrofitInstance fetches WebAppResponse → Repository saves to Local DB → returns data
7. WebAppActivity loads WebView with remote content
8. Utilities & SDKs are invoked as needed (e.g., AnalyticsUtils.logEvent, InstallReferrerManager.retrieveReferrer)

##### Architectural patterns & design principles
- MVVM separation of concerns
- Single source of truth in Repository
- Clean layering: Presentation → Domain → Data
- Dependency inversion: Activities & ViewModels depend on abstractions (Repository, DAO, ApiService)
- Local cache + remote fallback pattern
- Use of Android Jetpack components (Room, LiveData)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MA["MainActivity"]:::ui
        BA["BaseActivity"]:::ui
        WAA["WebAppsAdapter"]:::ui
        LP["language_popup.xml"]:::ui
        DL["dropdown_list.xml"]:::ui
        WA["WebAppActivity"]:::ui
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        HVM["HomeViewModel"]:::viewmodel
    end

    %% Repository Layer
    subgraph "Repository Layer"
        direction TB
        WAR["WebAppRepository"]:::repository
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        subgraph "Local Database"
            direction TB
            WDB["WebAppDatabase"]:::data
            WDao["WebAppDao"]:::data
            DBH["DatabaseHelper"]:::data
            AM["AppManifest"]:::data
            WE["WebApp"]:::data
        end
        subgraph "Remote API"
            direction TB
            RI["RetrofitInstance"]:::data
            AS["ApiService"]:::data
            WR["WebAppResponse"]:::data
        end
    end

    %% External Services
    subgraph "External Services"
        direction TB
        AU["AnalyticsUtils"]:::external
        IRM["InstallReferrerManager"]:::external
        SU["SlackUtils"]:::external
    end

    %% Utilities
    subgraph "Utilities & Helpers"
        direction TB
        CL["ConfigLoader"]:::utilities
        DLH["DeepLinkHelper"]:::utilities
        CU["CacheUtils"]:::utilities
        IL["ImageLoader"]:::utilities
        AP["AudioPlayer"]:::utilities
        OH["OtherHelpers"]:::utilities
        AMAsset["web_apps_manifest.json"]:::utilities
    end

    %% Connections
    MA -->|"userAction()"| HVM
    BA --> MA
    WAA --> MA
    MA -->|"launchWebApp()"| WA
    LP --> MA
    DL --> MA

    HVM -->|"getWebApps()"| WAR

    WAR -->|"queryCache()"| WDao
    WAR -->|"queryCache()"| WDB
    WAR -->|"fetchWebApps()"| RI
    RI -->|"calls ApiService"| AS
    AS -->|"returns JSON"| WR
    WR -->|"WebAppResponse JSON"| WAR
    WAR -->|"save()"| WDB
    WAR -->|"save()"| WDao

    WAR -->|"return LiveData"| HVM
    HVM -->|"observe()"| MA

    MA -->|"logEvent()"| AU
    MA -->|"retrieveReferrer()"| IRM
    MA -->|"notify()"| SU

    CL --> WAR
    DLH --> WAR
    CU --> WAR
    IL --> WAR
    AP --> WAR
    OH --> WAR
    AMAsset --> CL

    %% Click Events
    click MA "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/MainActivity.java"
    click BA "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/presentation/base/BaseActivity.java"
    click WAA "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/presentation/adapters/WebAppsAdapter.java"
    click LP "https://github.com/chimple/crcontainer/blob/main/app/src/main/res/layout/language_popup.xml"
    click DL "https://github.com/chimple/crcontainer/blob/main/app/src/main/res/layout/dropdown_list.xml"
    click HVM "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/presentation/viewmodals/HomeViewModal.java"
    click WAR "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/respository/WebAppRepository.java"
    click WDB "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/database/WebAppDatabase.java"
    click WDao "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/database/WebAppDao.java"
    click DBH "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/database/DatabaseHelper.java"
    click AM "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/local/AppManifest.java"
    click WE "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/model/WebApp.java"
    click WR "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/model/WebAppResponse.java"
    click RI "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/remote/RetrofitInstance.java"
    click AS "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/data/remote/ApiService.java"
    click AU "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/firebase/AnalyticsUtils.java"
    click IRM "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/installreferrer/InstallReferrerManager.java"
    click SU "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/SlackUtils.java"
    click CL "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/ConfigLoader.java"
    click DLH "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/DeepLinkHelper.java"
    click CU "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/CacheUtils.java"
    click IL "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/ImageLoader.java"
    click AP "https://github.com/chimple/crcontainer/blob/main/app/src/main/java/org/curiouslearning/container/utilities/AudioPlayer.java"
    click OH "https://github.com/chimple/crcontainer/tree/main/app/src/main/java/org/curiouslearning/container/utilities/"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef viewmodel fill:#D5F5F6,stroke:#1ABC9C,color:#1ABC9C
    classDef repository fill:#E9F7EF,stroke:#27AE60,color:#27AE60
    classDef data fill:#FEF5E7,stroke:#F39C12,color:#F39C12
    classDef external fill:#F4ECF7,stroke:#8E44AD,color:#8E44AD
    classDef utilities fill:#F2F3F4,stroke:#7F8C8D,color:#7F8C8D
```
