Android Platform Starter

Production-shaped Android template for Principal-level teams — modular architecture, Compose UI, Hilt DI, Detekt, and CI quality gates out of the box.

---

Why this exists

New Android codebases fail when architecture decisions are deferred. This starter encodes opinionated defaults so teams ship with:

• Clear module boundaries (app → feature → core)
• Testable domain use cases
• Compose + Material 3 design system module
• Static analysis and CI from day one

Use it to bootstrap greenfield apps, align teams on conventions, or as a reference in architecture reviews.

Module map

app/                  Application shell, Hilt entry point
feature/home/         Feature UI + ViewModel + navigation-ready screen
core/domain/          Models, repository contracts, use cases (JVM)
core/data/            Repository implementations, Hilt data bindings
core/designsystem/    Theme + reusable Compose components
core/common/          Shared primitives (Result, utilities)

Architecture

flowchart TB
    subgraph presentation [Presentation]
        App[app]
        Feature[feature:home]
    end
    subgraph core_layer [Core]
        Domain[core:domain]
        Data[core:data]
        Design[core:designsystem]
        Common[core:common]
    end
    App --> Feature
    Feature --> Domain
    Feature --> Design
    Data --> Domain
    Domain --> Common

Loading

Concern	Implementation
UI	Jetpack Compose, Material 3, StateFlow UI state
DI	Hilt modules per layer
Domain	Use cases + repository interfaces
Data	Fake repository (swap for Retrofit/Room)
Quality	Detekt, JVM + Android unit tests, GitHub Actions

Architecture decisions

Significant choices are documented as ADRs in docs/adr/. Start there when forking or reviewing this template.

Writing

• Performance budgets with Macrobenchmark

Stack

Kotlin · Jetpack Compose · Hilt · Coroutines/Flow · Gradle Kotlin DSL · Detekt · GitHub Actions

Getting started

Prerequisites

• Android Studio Hedgehog or newer
• JDK 17+
• Android SDK 34

Build

./gradlew assembleDebug
./gradlew installDebug

Quality checks

./gradlew detekt
./gradlew :core:domain:test :feature:home:testDebugUnitTest

CI

Every push and PR runs Detekt, unit tests, and assembleDebug.

Extending the template

1. Add feature:<name> modules for new user flows
2. Replace FakeCatalogRepository with network/local data sources
3. Introduce build-logic convention plugins for org-wide Gradle policy
4. Run performance benchmarks (see below)

Performance engineering

The benchmark module includes Macrobenchmark startup tests and a Baseline Profile generator.

# Compile benchmark harness
./gradlew :benchmark:assemble

# Run on a physical device (requires connected hardware)
./gradlew :benchmark:connectedBenchmarkReleaseAndroidTest

This encodes performance regression gates—the difference between "we care about architecture" and "we care about user-perceived speed."

Related showcase repos

• sliide-kmp-user-management — KMP + MVI + SQLDelight
• compose-commerce-catalog — Compose + golden tests
• compose-movies-finder — multi-module TMDB client

License

MIT — see LICENSE.