# android/nowinandroid architecture

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

- Interactive diagram: https://gitdiagram.com/android/nowinandroid
- Repository: https://github.com/android/nowinandroid

## Overview

#### Purpose and Entry Points
Now in Android is a modular Kotlin/Jetpack Compose Android reference app for browsing Android-development news, following topics, bookmarking content, searching, and receiving matching-content notifications. The primary installable app starts through `app/src/main/kotlin/com/google/samples/apps/nowinandroid/NiaApplication.kt` and `app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivity.kt`, which renders the root Compose shell in `app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaApp.kt`. `app-nia-catalog` is a separate component-catalog application, entered by `app-nia-catalog/src/main/kotlin/com/google/samples/apps/niacatalog/NiaCatalogActivity.kt`.

#### Application Shell and Navigation
The app module owns process-level Hilt setup, activity lifecycle integration, adaptive app state, top-level navigation, theme selection, and app-wide performance instrumentation. `MainActivityViewModel.kt` prepares startup/UI state; `NiaAppState.kt` coordinates navigation and window/layout concerns. Navigation is abstracted behind `core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt` and `NavigationState.kt`, keeping feature destinations decoupled from the app shell.

#### Feature Boundaries
User-facing capabilities are split into API and implementation modules. API modules expose typed navigation keys; implementation modules supply Compose entry providers, screens, and ViewModels. Representative paths are:
- For You/onboarding feed: `feature/foryou/api/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/api/navigation/ForYouNavKey.kt`, `feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt`.
- Interests and topic detail: `feature/interests/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/interests/impl/InterestsScreen.kt`, `feature/topic/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/topic/impl/TopicViewModel.kt`.
- Bookmarks and search: `feature/bookmarks/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/bookmarks/impl/BookmarksViewModel.kt`, `feature/search/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/search/impl/SearchViewModel.kt`.
Settings is a dialog-oriented feature backed by persisted user preferences.

#### Data, Domain, and Persistence Flow
Features consume repository interfaces and domain use cases, producing observable UI state in ViewModels. Shared business models live in `core/model/src/main/kotlin/com/google/samples/apps/nowinandroid/core/model/data/`. Search and topic-following orchestration is isolated in use cases such as `core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt`. The data layer implements offline-first repositories—e.g., `core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt` and `OfflineFirstUserDataRepository.kt`—which bridge network sync, Room, DataStore preferences, connectivity, and analytics.

Room is the local content/search cache via `core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/NiaDatabase.kt` and its DAOs. Proto DataStore persists theme, followed topics, bookmarks, and sync versions through `core/datastore/src/main/kotlin/com/google/samples/apps/nowinandroid/core/datastore/NiaPreferencesDataSource.kt` and `core/datastore-proto/src/main/proto/com/google/samples/apps/nowinandroid/data/user_preferences.proto`.

#### External Boundaries and Background Work
`core/network` defines `NiaNetworkDataSource.kt`; the demo flavor serves bundled `news.json`/`topics.json`, while production uses `RetrofitNiaNetwork.kt` against a non-public backend. Flavor-specific bindings select these implementations. WorkManager schedules and executes synchronization through `sync/work/src/main/kotlin/com/google/samples/apps/nowinandroid/sync/workers/SyncWorker.kt` and `WorkManagerSyncManager.kt`. Production can subscribe to Firebase-driven sync events and display notification updates. Firebase Analytics is similarly production-bound in `core/analytics/src/prod/kotlin/com/google/samples/apps/nowinandroid/core/analytics/FirebaseAnalyticsHelper.kt`; `app/google-services.json` configures Google services.

#### UI System and Dependency Composition
Compose screens depend on shared visual primitives and feed components rather than direct platform UI: `core/designsystem/src/main/kotlin/com/google/samples/apps/nowinandroid/core/designsystem/theme/Theme.kt`, `core/ui/src/main/kotlin/com/google/samples/apps/nowinandroid/core/ui/NewsFeed.kt`. Hilt modules at data/database/network boundaries bind interfaces to flavor-specific implementations, enabling demo, production, and test substitutions.

#### Build, Delivery, and Performance
Gradle convention plugins centralize Android, Compose, Hilt, Room, flavor, and quality policy under `build-logic/convention/src/main/kotlin/`. Main variants are `demo` (bundled data), `prod` (remote backend), plus `benchmark`; normal development targets `demoDebug`. Macrobenchmarks and baseline-profile journeys reside in `benchmarks/src/main/kotlin/com/google/samples/apps/nowinandroid/baselineprofile/` and support startup and critical navigation optimization. GitHub Actions build, release, and nightly profile workflows are in `.github/workflows/`.

Main entry points: [`core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt`](https://github.com/android/nowinandroid/blob/main/core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt) (Navigation abstraction), [`core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt`](https://github.com/android/nowinandroid/blob/main/core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt) (Offline-first repositories), [`core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt`](https://github.com/android/nowinandroid/blob/main/core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt) (Domain use cases), [`feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt`](https://github.com/android/nowinandroid/blob/main/feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt) (For You)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App shell"]
  node_main_activity["Main activity<br/>Android entry<br/>[MainActivity.kt]"]
  node_application["Nia application<br/>Hilt application<br/>[NiaApplication.kt]"]
  node_app_shell["Compose app shell<br/>root UI<br/>[NiaApp.kt]"]
  node_navigation["Navigation abstraction<br/>navigation API<br/>[Navigator.kt]"]
  node_catalog_app["Component catalog<br/>separate app"]
end

subgraph group_features["Feature modules"]
  node_foryou["For You<br/>feature API + impl<br/>[ForYouViewModel.kt]"]
  node_interests_topic["Interests and topics<br/>feature impl<br/>[InterestsScreen.kt]"]
  node_bookmarks["Bookmarks<br/>feature impl"]
  node_search["Search<br/>feature impl<br/>[SearchViewModel.kt]"]
  node_shared_ui["Design system and UI<br/>Compose shared UI<br/>[Theme.kt]"]
end

subgraph group_data["Data and platform"]
  node_domain["Domain use cases<br/>domain layer"]
  node_repositories["Offline-first repositories<br/>data layer"]
  node_database[("Room content cache<br/>local database<br/>[NiaDatabase.kt]")]
  node_preferences[("Proto DataStore<br/>user state store")]
  node_network["Network data source<br/>remote boundary"]
  node_sync["WorkManager sync<br/>background work<br/>[SyncWorker.kt]"]
end

subgraph group_delivery["Variants and delivery"]
  node_firebase["Firebase services<br/>production integration"]
  node_build_variants["Convention build and variants<br/>Gradle build logic"]
  node_benchmarks["Baseline profiles<br/>performance pipeline"]
  node_ci["GitHub Actions<br/>CI workflows"]
end

node_application -->|"initializes"| node_main_activity
node_main_activity -->|"renders"| node_app_shell
node_app_shell -->|"uses"| node_navigation
node_navigation -->|"routes to"| node_foryou
node_navigation -->|"routes to"| node_interests_topic
node_navigation -->|"routes to"| node_bookmarks
node_navigation -->|"routes to"| node_search
node_foryou -->|"composes"| node_shared_ui
node_interests_topic -->|"composes"| node_shared_ui
node_bookmarks -->|"consumes"| node_domain
node_search -->|"queries through"| node_domain
node_foryou -->|"consumes"| node_domain
node_interests_topic -->|"consumes"| node_domain
node_domain -->|"uses"| node_repositories
node_repositories -->|"reads and writes"| node_database
node_repositories -->|"reads and writes"| node_preferences
node_repositories -->|"syncs with"| node_network
node_sync -->|"synchronizes"| node_repositories
node_firebase -.->|"triggers in prod"| node_sync
node_build_variants -.->|"selects demo/prod binding"| node_network
node_build_variants -.->|"builds variants"| node_application
node_benchmarks -.->|"measures journeys"| node_app_shell
node_ci -.->|"runs builds and releases"| node_build_variants

click node_main_activity "https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivity.kt"
click node_application "https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/NiaApplication.kt"
click node_app_shell "https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaApp.kt"
click node_navigation "https://github.com/android/nowinandroid/blob/main/core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt"
click node_catalog_app "https://github.com/android/nowinandroid/blob/main/app-nia-catalog/src/main/kotlin/com/google/samples/apps/niacatalog/NiaCatalogActivity.kt"
click node_foryou "https://github.com/android/nowinandroid/blob/main/feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt"
click node_interests_topic "https://github.com/android/nowinandroid/blob/main/feature/interests/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/interests/impl/InterestsScreen.kt"
click node_bookmarks "https://github.com/android/nowinandroid/blob/main/feature/bookmarks/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/bookmarks/impl/BookmarksViewModel.kt"
click node_search "https://github.com/android/nowinandroid/blob/main/feature/search/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/search/impl/SearchViewModel.kt"
click node_shared_ui "https://github.com/android/nowinandroid/blob/main/core/designsystem/src/main/kotlin/com/google/samples/apps/nowinandroid/core/designsystem/theme/Theme.kt"
click node_domain "https://github.com/android/nowinandroid/blob/main/core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt"
click node_repositories "https://github.com/android/nowinandroid/blob/main/core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt"
click node_database "https://github.com/android/nowinandroid/blob/main/core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/NiaDatabase.kt"
click node_preferences "https://github.com/android/nowinandroid/blob/main/core/datastore/src/main/kotlin/com/google/samples/apps/nowinandroid/core/datastore/NiaPreferencesDataSource.kt"
click node_network "https://github.com/android/nowinandroid/blob/main/core/network/src/main/kotlin/com/google/samples/apps/nowinandroid/core/network/NiaNetworkDataSource.kt"
click node_sync "https://github.com/android/nowinandroid/blob/main/sync/work/src/main/kotlin/com/google/samples/apps/nowinandroid/sync/workers/SyncWorker.kt"
click node_firebase "https://github.com/android/nowinandroid/blob/main/core/analytics/src/prod/kotlin/com/google/samples/apps/nowinandroid/core/analytics/FirebaseAnalyticsHelper.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main_activity,node_application,node_app_shell,node_navigation,node_catalog_app toneBlue
class node_foryou,node_interests_topic,node_bookmarks,node_search,node_shared_ui toneAmber
class node_domain,node_repositories,node_database,node_preferences,node_network,node_sync toneMint
class node_firebase,node_build_variants,node_benchmarks,node_ci toneRose
```

## Components

### App shell

- [Main activity](https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivity.kt): Android entry · Hosts the primary Compose application. · `app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivity.kt`
- [Nia application](https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/NiaApplication.kt): Hilt application · Initializes process-level dependencies. · `app/src/main/kotlin/com/google/samples/apps/nowinandroid/NiaApplication.kt`
- [Compose app shell](https://github.com/android/nowinandroid/blob/main/app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaApp.kt): root UI · Owns adaptive layout, theme, and top-level destinations. · `app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaApp.kt`
- [Navigation abstraction](https://github.com/android/nowinandroid/blob/main/core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt): navigation API · Decouples app shell from feature destinations. · `core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/Navigator.kt`
- [Component catalog](https://github.com/android/nowinandroid/blob/main/app-nia-catalog/src/main/kotlin/com/google/samples/apps/niacatalog/NiaCatalogActivity.kt): separate app · Standalone catalog activity for UI components. · `app-nia-catalog/src/main/kotlin/com/google/samples/apps/niacatalog/NiaCatalogActivity.kt`

### Feature modules

- [For You](https://github.com/android/nowinandroid/blob/main/feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt): feature API + impl · Onboarding and personalized feed. · `feature/foryou/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/impl/ForYouViewModel.kt`
- [Interests and topics](https://github.com/android/nowinandroid/blob/main/feature/interests/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/interests/impl/InterestsScreen.kt): feature impl · Topic discovery, following, and detail. · `feature/interests/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/interests/impl/InterestsScreen.kt`
- [Bookmarks](https://github.com/android/nowinandroid/blob/main/feature/bookmarks/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/bookmarks/impl/BookmarksViewModel.kt): feature impl · `feature/bookmarks/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/bookmarks/impl/BookmarksViewModel.kt`
- [Search](https://github.com/android/nowinandroid/blob/main/feature/search/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/search/impl/SearchViewModel.kt): feature impl · `feature/search/impl/src/main/kotlin/com/google/samples/apps/nowinandroid/feature/search/impl/SearchViewModel.kt`
- [Design system and UI](https://github.com/android/nowinandroid/blob/main/core/designsystem/src/main/kotlin/com/google/samples/apps/nowinandroid/core/designsystem/theme/Theme.kt): Compose shared UI · Shared theme, primitives, and news-feed components. · `core/designsystem/src/main/kotlin/com/google/samples/apps/nowinandroid/core/designsystem/theme/Theme.kt`

### Data and platform

- [Domain use cases](https://github.com/android/nowinandroid/blob/main/core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt): domain layer · Orchestrates search and topic-following flows. · `core/domain/src/main/kotlin/com/google/samples/apps/nowinandroid/core/domain/GetSearchContentsUseCase.kt`
- [Offline-first repositories](https://github.com/android/nowinandroid/blob/main/core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt): data layer · Bridge local state, sync, connectivity, and analytics. · `core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/OfflineFirstNewsRepository.kt`
- [Room content cache](https://github.com/android/nowinandroid/blob/main/core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/NiaDatabase.kt): local database · Caches content and powers local search. · `core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/NiaDatabase.kt`
- [Proto DataStore](https://github.com/android/nowinandroid/blob/main/core/datastore/src/main/kotlin/com/google/samples/apps/nowinandroid/core/datastore/NiaPreferencesDataSource.kt): user state store · Persists preferences, follows, bookmarks, and sync versions. · `core/datastore/src/main/kotlin/com/google/samples/apps/nowinandroid/core/datastore/NiaPreferencesDataSource.kt`
- [Network data source](https://github.com/android/nowinandroid/blob/main/core/network/src/main/kotlin/com/google/samples/apps/nowinandroid/core/network/NiaNetworkDataSource.kt): remote boundary · Demo uses bundled data; prod uses Retrofit backend. · `core/network/src/main/kotlin/com/google/samples/apps/nowinandroid/core/network/NiaNetworkDataSource.kt`
- [WorkManager sync](https://github.com/android/nowinandroid/blob/main/sync/work/src/main/kotlin/com/google/samples/apps/nowinandroid/sync/workers/SyncWorker.kt): background work · Schedules and executes repository synchronization. · `sync/work/src/main/kotlin/com/google/samples/apps/nowinandroid/sync/workers/SyncWorker.kt`

### Variants and delivery

- [Firebase services](https://github.com/android/nowinandroid/blob/main/core/analytics/src/prod/kotlin/com/google/samples/apps/nowinandroid/core/analytics/FirebaseAnalyticsHelper.kt): production integration · Provides analytics and sync-triggered notifications. · `core/analytics/src/prod/kotlin/com/google/samples/apps/nowinandroid/core/analytics/FirebaseAnalyticsHelper.kt`
- **Convention build and variants**: Gradle build logic · Defines Compose, Hilt, Room, quality, and demo/prod/benchmark policy.
- **Baseline profiles**: performance pipeline · Captures startup and navigation optimization journeys.
- **GitHub Actions**: CI workflows · Builds, releases, and runs nightly profile workflows.

## Connections

- Nia application → Main activity: initializes
- Main activity → Compose app shell: renders
- Compose app shell → Navigation abstraction: uses
- Navigation abstraction → For You: routes to
- Navigation abstraction → Interests and topics: routes to
- Navigation abstraction → Bookmarks: routes to
- Navigation abstraction → Search: routes to
- For You → Design system and UI: composes
- Interests and topics → Design system and UI: composes
- Bookmarks → Domain use cases: consumes
- Search → Domain use cases: queries through
- For You → Domain use cases: consumes
- Interests and topics → Domain use cases: consumes
- Domain use cases → Offline-first repositories: uses
- Offline-first repositories → Room content cache: reads and writes
- Offline-first repositories → Proto DataStore: reads and writes
- Offline-first repositories → Network data source: syncs with
- WorkManager sync → Offline-first repositories: synchronizes
- Firebase services → WorkManager sync: triggers in prod
- Convention build and variants → Network data source: selects demo/prod binding
- Convention build and variants → Nia application: builds variants
- Baseline profiles → Compose app shell: measures journeys
- GitHub Actions → Convention build and variants: runs builds and releases
