# jbvincey/instantappsample architecture

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

- Interactive diagram: https://gitdiagram.com/jbvincey/instantappsample
- Repository: https://github.com/jbvincey/instantappsample

## Overview

##### Project Type and Purpose
- This is an Android Instant App sample demonstrating how to take a regular Android application and turn it into an Instant App with one or more feature modules.
- It uses the Model-View-Presenter (MVP) pattern, and is organized into multiple Gradle modules:
– A base feature module (formerly “app”)
– An installed APK wrapper module
– An Instant App wrapper module
– Two feature modules (Trip List and Trip Details)

##### High-Level Module Analysis
At the top level you have:
- instanttripapk (the “installed” application wrapper)
- instanttripinstantapp (the Instant App wrapper)
- instanttripbase (the base feature module containing common code and configuration)
- instanttriplist (feature module for the list of trips)
- instanttripdetails (feature module for trip details)

Relationships:
- instanttripapk and instanttripinstantapp both depend on instanttripbase (and, in the multi-feature setup, also on instanttriplist and instanttripdetails).
- instanttripbase declares its feature modules using Gradle “feature project(…)” directives.
- The two feature modules each contain their own Activities, layouts, and use API-level code from instanttripbase (models, repositories, helpers, presenters).

##### Core Components and Layers
Within the base feature module (instanttripbase):
- Application class: InstantAppSampleApplication
- Dependency injection setup: DependencyManager, RepositoryModule
- Data layer: TripRepository (reads trips.json from assets)
- Domain models: Trip, Coordinates
- Helpers and constants: IntentHelper, ResourceHelper, Constants

In each feature module (instanttriplist, instanttripdetails):
- UI: MainActivity or DetailsActivity, layouts (activity_main.xml, item_trip.xml, activity_detail.xml)
- Presenter: MainPresenter, DetailPresenter
- Adapter (list only): TripAdapter
- Feature-specific R resources

##### Interaction and Data Flow
- Activity ←→ Presenter: View calls Presenter to load data or handle user events; Presenter pushes data back to View.
- Presenter → Repository: Presenter requests data (e.g., list of trips or single trip) from TripRepository.
- Repository → Assets: Repository loads JSON from assets/trips/trips.json.
- Activity navigates to Detail feature by firing an Intent with a URL (IntentHelper).

##### Architectural Patterns and Principles
- Modular Feature-Based Architecture for Instant Apps: separate modules for each addressable feature
- Single base feature for shared code and resources
- Wrapper Application modules (installed vs. instant) that simply depend on features
- MVP pattern: clear separation between View (Activity), Presenter, and Model/Repository
- Explicit Intent-based navigation, using App Links (URL mapping) for instant modules

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Title
    subgraph "InstantAppSample Architecture – Multi-Module MVP Instant App"
    end

    %% External System
    AndroidFramework(["Android Framework"]):::external

    %% Wrapper Modules
    subgraph "Wrapper Modules" 
        direction LR
        instanttripapk["instanttripapk\n(installed APK wrapper)"]:::module
        instanttripinstantapp["instanttripinstantapp\n(Instant App wrapper)"]:::module
    end

    AndroidFramework -->|"Intent resolution"| instanttripapk
    AndroidFramework -->|"URL/App Link"| instanttripinstantapp

    %% Base Feature Module
    instanttripapk -->|"implementation project(':instanttripbase')"| instanttripbaseModule
    instanttripinstantapp -->|"implementation project(':instanttripbase')"| instanttripbaseModule

    subgraph "instanttripbase\n(base feature)" 
        direction TB
        appClass(["InstantAppSampleApplication"]):::logic
        depManager(["DependencyManager"]):::logic
        repoModule(["RepositoryModule"]):::logic
        tripRepo(["TripRepository"]):::logic
        tripModel(["Trip"]):::data
        coordModel(["Coordinates"]):::data
        intentHelper(["IntentHelper"]):::logic
        resourceHelper(["ResourceHelper"]):::logic
        constants(["Constants"]):::logic
        tripsJSON(("trips.json")):::dataStore
    end

    instanttripbaseModule["instanttripbase"]:::module
    instanttripapk --> instanttripbaseModule
    instanttripinstantapp --> instanttripbaseModule

    instanttripbaseModule --> appClass
    appClass --> depManager
    depManager --> repoModule
    repoModule --> tripRepo
    tripRepo --> tripsJSON
    repoModule --> tripModel
    repoModule --> coordModel
    appClass --> intentHelper
    appClass --> resourceHelper
    appClass --> constants

    %% Feature Modules
    subgraph "instanttriplist\n(Trip List feature)" 
        direction TB
        mainActivity(["MainActivity"]):::ui
        mainPresenter(["MainPresenter"]):::logic
        tripAdapter(["TripAdapter"]):::ui
        layoutMain(["activity_main.xml"]):::ui
        layoutItem(["item_trip.xml"]):::ui
    end

    subgraph "instanttripdetails\n(Trip Details feature)" 
        direction TB
        detailActivity(["DetailActivity"]):::ui
        detailPresenter(["DetailPresenter"]):::logic
        layoutDetail(["activity_detail.xml"]):::ui
    end

    instanttripbaseModule -->|"feature project"| instanttriplist
    instanttripbaseModule -->|"feature project"| instanttripdetails

    instanttriplist --> mainActivity
    mainActivity -->|"calls"| mainPresenter
    mainPresenter -->|"requests"| tripRepo
    mainActivity -->|"binds"| tripAdapter
    mainActivity --> layoutMain
    mainActivity --> layoutItem

    instanttripdetails --> detailActivity
    detailActivity -->|"calls"| detailPresenter
    detailPresenter -->|"requests"| tripRepo
    detailActivity --> layoutDetail

    %% Shared Components
    subgraph "Shared UI & Presenters" 
        direction TB
        abstractActivity(["AbstractDrawerActivity"]):::ui
        basePresenter(["AbstractPresenter"]):::logic
        drawerPresenter(["DrawerPresenter"]):::logic
    end

    intentHelper --> abstractActivity
    abstractActivity --> drawerPresenter
    drawerPresenter --> basePresenter

    %% Click Events
    click instanttripapk "https://github.com/jbvincey/instantappsample/tree/master/app/"
    click appClass "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/InstantAppSampleApplication.java"
    click depManager "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/dependencies/DependencyManager.java"
    click repoModule "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/dependencies/RepositoryModule.java"
    click tripRepo "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/repositories/TripRepository.java"
    click tripModel "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/model/Trip.java"
    click coordModel "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/model/Coordinates.java"
    click intentHelper "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/helper/IntentHelper.java"
    click resourceHelper "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/helper/ResourceHelper.java"
    click constants "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/constants/Constants.java"
    click tripsJSON "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/assets/trips/trips.json"
    click mainActivity "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/activities/MainActivity.java"
    click layoutMain "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/res/layout/activity_main.xml"
    click layoutItem "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/res/layout/item_trip.xml"
    click mainPresenter "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/presenters/MainPresenter.java"
    click tripAdapter "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/adapters/TripAdapter.java"
    click detailActivity "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/activities/DetailActivity.java"
    click layoutDetail "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/res/layout/activity_detail.xml"
    click detailPresenter "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/presenters/DetailPresenter.java"
    click abstractActivity "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/activities/AbstractDrawerActivity.java"
    click basePresenter "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/presenters/AbstractPresenter.java"
    click drawerPresenter "https://github.com/jbvincey/instantappsample/blob/master/app/src/main/java/com/jbvincey/instantappssample/presenters/DrawerPresenter.java"

    %% Styles
    classDef module fill:#f0f8ff,stroke:#333,stroke-width:1px
    classDef ui fill:#ffe4e1,stroke:#333,stroke-width:1px
    classDef logic fill:#e6e6fa,stroke:#333,stroke-width:1px
    classDef data fill:#fafad2,stroke:#333,stroke-width:1px
    classDef dataStore fill:#d3ffd3,stroke:#333,stroke-width:1px
    classDef external fill:#fffacd,stroke:#333,stroke-width:1px
```
