How deference3/compose-calculator works
Project type and purpose
• This is an Android mobile application (“compose-calculator”) that implements a basic calculator UI using Jetpack Compose.
• It contains a single Gradle module (app/), using Kotlin, AndroidX, and Compose for UI, with unit and instrumentation tests.
File structure
• Top-level: Gradle wrappers and settings, GitHub Actions workflow (.github/workflows/android.yml), project-level build.gradle.
• Module app/:
• build.gradle, proguard-rules.pro
• src/main/java/com/diffy/calculator/
– Domain logic: Calculator.kt, CalculatorOperations.kt
– UI state & actions: CalculatorState.kt, CalculatorActions.kt
– ViewModel: CalculatorViewModel.kt
– Composable UI: CalculatorButton.kt, MainActivity.kt, theme files under ui/theme/
• Resources (res/): layouts are all Compose, plus drawables, mipmaps, values, XML backup/data rules.
• Tests: unit tests under src/test/…, instrumentation tests under src/androidTest/….
Extract insights from README
• Confirms it’s a simple Compose-based calculator.
• No mention of external services, databases, or network calls—purely local UI+logic.
Main components
a. Android OS & application host (Activity lifecycle)
b. MainActivity (entry point)
c. Jetpack Compose UI layer (Composable functions & theming)
d. ViewModel (state holder, exposes UI state & handles actions)
e. Domain logic (Calculator, CalculatorOperations)
f. UI state & actions model (CalculatorState, CalculatorActions)
g. Build system (Gradle) and test modules (unit tests, instrumentation tests)
Relationships and interactions
• User taps a button in the Compose UI → triggers a CalculatorActions event → passed to CalculatorViewModel.
• CalculatorViewModel processes the action by calling domain logic (Calculator.calculate() or CalculatorOperations) → updates CalculatorState.
• Updated CalculatorState is observed by Compose UI → UI recomposes to show new result.
• Gradle builds the app and runs tests; instrumentation tests execute on Android emulator/device against MainActivity; unit tests verify domain logic.
Architectural patterns and principles
• MVVM pattern: Composable UI ←→ ViewModel ←→ Domain logic
• Unidirectional data flow: actions flow down, state flows up
• Separation of concerns: UI, state management, and business logic are in distinct packages/files
• Use of Jetpack Compose for declarative UI