-3DDC84?style=flat&logo=android&logoColor=white){kind=icon}
A production-grade Android weather app built with Jetpack Compose, Clean Architecture (MVI in the home feature), and a Kotlin Multiplatform module structure. It shows real-time weather, air quality data, saved locations, and sunrise/sunset animations — with multi-language support and an in-app premium upgrade flow.
| Category | Details |
|---|---|
| Weather | Current conditions, feels-like temp, humidity, wind speed (:feature:home) |
| Air Quality | Real-time AQI with pollutant details (:feature:home) |
| Location | GPS-based auto-detection with fallback, saved locations list, and place search (:feature:finder) |
| Sunrise/Sunset | Custom animated sunrise/sunset arc (:common-ui module) |
| Multi-language | English, Bengali (বাংলা), Hindi (हिन्दी), Kannada (ಕನ್ನಡ), Malayalam (മലയാളം), Tamil (தமிழ்), Telugu (తెలుగు), Hebrew (עברית) via Per-App Language API (:feature:language KMP module) |
| Premium | In-app purchase flow via Razorpay, surfaced as a bottom sheet inside Settings |
| Notifications | Firebase Cloud Messaging (FCM) push notifications |
| In-App Updates | Google Play in-app update prompts (InAppUpdateManager) |
| Remote Config | Server-driven feature flags gating the home experience (Firebase Remote Config, iOS + Android) |
| Theming | Material 3 + dynamic color + dark/light mode |
The project is split into clearly bounded Gradle modules. Everything except :app is a Kotlin Multiplatform (KMP) module (org.jetbrains.kotlin.multiplatform + com.android.kotlin.multiplatform.library plugins) with commonMain/androidMain/iosMain source sets — making the app iOS-portable without a full rewrite. :app stays a plain Android application module and is the only place Hilt is used; every KMP module uses Koin, bridged into :app's Hilt graph via a Koin-Hilt adapter module.
graph TD
subgraph APP["🟦 :app (Android, Hilt)"]
A["WeatherifyApplication\nMainActivity\nAppNavigation - Nav3\nAppPermissionViewModel / SettingsViewModel"]
end
subgraph HOME["🟨 :feature:home (KMP, Koin, MVI)"]
I["HomeFeatureRoute / HomeViewModel\nHomeReducer / HomeIntent / HomeAction / HomeEffect\nGetWeatherReport / GetAirQuality / RefreshWeatherReport\nWeatherRepositoryImpl / LocationClient / HomeGeocoder"]
end
subgraph COMMON["🟩 :common-ui (KMP, Koin)"]
B["SettingsScreen\nInAppWebView\nSunrise/Sunset Canvas Animation\nPermissionDialog\nDateFormatter"]
end
subgraph AUTH["🟦 :feature:auth (KMP, Koin)"]
H["LoginScreen\nAuthViewModel\nDeviceInfoProvider\ndomain-only, no data layer"]
end
subgraph PAYMENT["🟨 :feature:payment (KMP, Koin)"]
C["PaymentViewModel\nCreateOrderUseCase\nVerifyPaymentUseCase\nPremiumStore\nRazorpay checkout"]
end
subgraph NETWORK["🟧 :network (KMP, Koin)"]
D["Ktor Client\nWeatherApi\nKotlinx Serialization"]
end
subgraph STORAGE["🟥 :storage (KMP, Koin)"]
E["Room Database\nDataStore Preferences (incl. location prefs)\nWeatherDao"]
end
subgraph LANGUAGE["🟪 :feature:language (KMP, Koin)"]
F["LanguageScreen\nLocaleHelper"]
end
subgraph FINDER["🔍 :feature:finder (KMP, Koin)"]
G["SavedLocationsScreen\nPlaceSearchDialog\nGetSavedLocationsUseCase\nFinderRepository / Impl"]
end
APP --> HOME
APP --> COMMON
APP --> AUTH
APP --> PAYMENT
APP --> NETWORK
APP --> STORAGE
APP --> LANGUAGE
APP --> FINDER
DI note:
:appuses Hilt for its own ViewModels (SettingsViewModel,AppPermissionViewModel). Every KMP module (:feature:home,:common-ui,:feature:*,:network,:storage) uses Koin internally.app/.../di/PaymentKoinModule.ktbridges the two graphs so Hilt-managed code can resolve Koin-provided dependencies (e.g.PaymentViewModel).
Each feature is structured across three layers, with dependency arrows pointing inward — the domain layer has zero Android or framework dependencies. :feature:home, :feature:finder, and :feature:payment follow this strictly with a full domain/ + data/ split (repository interfaces vs. impls, use cases, mappers). :feature:home's presentation layer additionally follows an MVI pattern (HomeIntent → HomeReducer → HomeState/HomeEffect) rather than plain imperative state updates. :feature:auth is lighter-weight: it only defines a domain/DeviceInfoProvider interface with a platform-specific implementation wired directly through Koin — there is no separate data/ package for auth.
graph LR
subgraph Presentation["🎨 Presentation Layer"]
UI["Compose Screens\n(HomeFeatureRoute, SavedLocationsScreen\nSettingsScreen, LoginScreen, LanguageScreen)"]
VM["ViewModels\n(HomeViewModel [MVI], PaymentViewModel\nAuthViewModel, SettingsViewModel)"]
UI -- "UI Events / Intents" --> VM
VM -- "UI State (StateFlow)" --> UI
end
subgraph Domain["🧠 Domain Layer"]
UC["Use Cases\n(GetWeatherReport, GetAirQuality, RefreshWeatherReport\nGetSavedLocationsUseCase\nCreateOrderUseCase, VerifyPaymentUseCase...)"]
REPO_IF["Repository Interfaces\n(WeatherRepository, FinderRepository, PaymentRepository...)"]
UC --> REPO_IF
end
subgraph Data["💾 Data Layer"]
REPO_IMPL["Repository Impls\n(WeatherRepositoryImpl, FinderRepositoryImpl\nPaymentRepositoryImpl)"]
MAPPER["Mappers\n(Network → Storage\nStorage → Domain)"]
REPO_IMPL --> MAPPER
end
subgraph External["🌐 External Sources"]
NET[":network\nKtor + OpenWeatherMap API"]
DB[":storage\nRoom DB + DataStore"]
PAY["Razorpay SDK"]
end
VM -- "calls" --> UC
UC -- "calls" --> REPO_IF
REPO_IF -. "implemented by" .-> REPO_IMPL
REPO_IMPL --> NET
REPO_IMPL --> DB
REPO_IMPL --> PAY
The app runs on Jetpack Navigation 3 (androidx.navigation3), not the older NavHost/NavController API. AppNavigation.kt builds an entryProvider and renders it through NavDisplay, driven by a custom AppNavigator / rememberAppNavigationState() wrapper around the Nav3 backstack. Routes are @Serializable NavKey objects defined in Routes.kt. The bottom bar (AppBottomBar.kt) drives three top-level tabs: Home, Saved Locations, and Settings.
graph TD
Home["HomeRoute\n(HomeFeatureRoute — :feature:home)"] -->|bottom bar| Saved["SavedLocationsRoute\n(SavedLocationsFinderRoute — :feature:finder)"]
Home -->|bottom bar| Settings["SettingsRoute\n(SettingsScreen — :common-ui)"]
Settings -->|language row, API 33+| Language["LanguageRoute(languages)\n(LanguageScreen — :feature:language)"]
Settings -.->|API < 33| SystemSettings["System App Locale Settings"]
Settings -->|premium bottom sheet| Payment["Razorpay checkout\n(PaymentViewModel, in-place sheet — no route)"]
Notes:
- There is no standalone
ProfileScreenorPaymentScreenroute — profile info and the premium upgrade flow are both embedded insideSettingsScreen(profile header + aPremiumBottomSheet). InAppWebViewis a composable (not a route) shown conditionally insideSettingsScreenfor Terms/Privacy links.- On Android 13+ (
isDeviceSDKAndroid13OrAbove()), language selection pushesLanguageRoute; below API 33 it deep-links to the system per-app language settings instead. Routes.ktstill declares aCitiesListRoute, but it is not wired into theentryProvider— the quick city switcher was superseded by:feature:finder's saved-locations flow.
OpenWeatherMap API
│ JSON (Ktor + Kotlinx Serialization)
▼
:network module ──────► Network Models
│
NetworkToStorageMapper
│
▼
:storage module (Room DB / DataStore)
│
Storage → Domain mapper
│
▼
Domain Models
│
Use Cases (:feature:home domain layer)
│
▼
HomeViewModel — HomeIntent → HomeReducer → HomeState
│
▼
Jetpack Compose UI (screens, via Nav3 NavDisplay)
| Library | Version | Purpose |
|---|---|---|
| Jetpack Compose BOM | 2026.06.00 |
Declarative UI framework |
| Compose Multiplatform | 1.11.1 |
Shared Compose UI for KMP modules |
| Material 3 | 1.9.0 |
Design system + dynamic theming |
Navigation 3 (androidx.navigation3) |
1.1.4 |
Type-safe backstack + NavDisplay/entryProvider |
| Lifecycle ViewModel Nav3 | 2.11.0 |
ViewModel scoping for Nav3 entries |
| Coil Compose | 2.7.0 (Android) / Coil3 3.4.0 (KMP modules) |
Async image loading |
| Splash Screen API | 1.2.0 |
Android 12+ splash screen |
| Library | Version | Purpose |
|---|---|---|
| Hilt | 2.59.2 |
Dependency injection — :app module only |
| Koin | 4.2.2 |
DI in all KMP modules (:feature:home, :common-ui, :feature:*, :network, :storage) |
| Kotlin Coroutines | 1.11.0 |
Async & structured concurrency |
| StateFlow / Flow | — | Reactive UI state management |
| Library | Version | Purpose |
|---|---|---|
| Ktor Client | 3.5.1 |
KMP-compatible HTTP client |
| Kotlinx Serialization | 1.11.0 |
JSON parsing |
| OkHttp MockWebServer | 4.12.0 |
Network mocking (declared; not yet exercised by tests — see Testing) |
| Library | Version | Purpose |
|---|---|---|
| Room | 2.8.4 |
SQLite ORM (weather cache) — requires 2.7+ to emit Kotlin under the KMP Android library plugin |
| DataStore Preferences | 1.2.1 |
Key-value persistent settings, incl. location preferences |
| Kotlinx DateTime | 0.8.0 |
KMP-compatible date/time |
| SDK | Purpose |
|---|---|
Firebase BOM 34.15.0 |
BoM for consistent versions |
| Analytics | Declared dependency; no explicit logEvent calls in code yet (auto-instrumentation only) |
| Remote Config | Server-driven feature flags (HomeRemoteConfigGate, Android + iOS implementations) |
| Performance Monitoring | Network + rendering metrics |
| Cloud Messaging (FCM) | Push notifications (WeatherifyMessagingService) |
| Library | Purpose | Status |
|---|---|---|
| JUnit 4 + Truth | Unit assertions | 2 real test files in app/src/test |
Turbine 1.2.1 |
Flow/StateFlow testing | Declared, not yet exercised |
Mockk 1.14.11 |
Kotlin-first mocking | Declared, not yet exercised |
| Mockito + Nhaarman | Java-style mocking | Declared, not yet exercised |
Espresso 3.7.0 + Hilt Testing |
Instrumentation UI tests | Declared; no androidTest sources exist yet |
See Testing Status below — the test table above reflects declared dependencies, not actual coverage.
| Library | Purpose |
|---|---|
Timber 5.0.1 |
Structured logging |
LeakCanary 2.14 |
Memory leak detection (debug) |
Razorpay 1.6.41 |
In-app payment checkout |
| Google Play In-App Update | Forced/flexible update prompts (InAppUpdateManager) |
Google Play Location 21.3.0 |
FusedLocationProvider |
MainActivity (Hilt entry point)
└── AppNavigation (Nav3 NavDisplay + entryProvider)
├── HomeFeatureRoute — current weather + AQI card, MVI-driven (:feature:home)
├── SavedLocationsFinderRoute — manage saved locations & search new places (:feature:finder)
├── SettingsScreen — profile header, language row, notification toggle, (:common-ui)
│ premium bottom sheet, and in-app Terms/Privacy web view
│ └── InAppWebView — in-app browser composable, not a separate route (:common-ui)
├── LanguageScreen — per-app language picker (Android 13+ only) (:feature:language)
└── LoginScreen — authentication entry point (:feature:auth)
There is no standalone
ProfileScreenorPaymentScreen— both live insideSettingsScreen.
Test infrastructure (Espresso, Hilt Testing, MockWebServer, commonTest/iosTest source sets in :storage/:network) is declared in the build files, but real coverage today is minimal:
app/src/test/— 2 unit tests (common/ExtensionTest.kt,base/DateTimeUtilsTest.kt)- No
androidTestdirectory exists in any module :storageand:networkdeclarecommonTest/iosTestsource sets with no test files in them
This is a known gap, not a design choice — treat the Testing table above as the target stack, not current coverage.
- Android Studio Narwhal or later
- JDK 17 (JDK 21 is used by CI)
- An OpenWeatherMap API key (free tier works)
-
Clone the repo
git clone https://github.com/bosankus/Compose-Weatherify.git cd Compose-Weatherify -
Add your API key to
local.properties(create the file if it doesn't exist):OPEN_WEATHER_API_KEY=your_api_key_here -
Add
google-services.jsontoapp/(from Firebase console — required for Analytics/FCM to compile). -
Build & run
./gradlew assembleDebug # or just hit Run in Android Studio
Minimum Android version: API 28 (Android 9 Pie) Compile / Target SDK: 37
All style/lint versions and rules come from gradle/libs.versions.toml and config/detekt.yml, applied consistently across every subproject from the root build.gradle.kts.
| Task | What it does |
|---|---|
spotlessCheckAll |
Checks Kotlin/ktlint formatting across all modules (no changes made) |
detektAll |
Runs static analysis across all modules (no changes made) |
codeCheck |
spotlessCheckAll + detektAll — the full audit, matches CI's lint job |
spotlessApplyAll |
Auto-formats Kotlin/ktlint across all modules |
detektAllAutoCorrect |
Auto-corrects the subset of detekt rules that support it |
codeFormat |
spotlessApplyAll + detektAllAutoCorrect — the full auto-fix, matches CI's formatting step |
Before opening a PR, run everything in one shot:
./gradlew spotlessApplyAll detektAllAutoCorrect codeFormatcodeFormat already depends on spotlessApplyAll and detektAllAutoCorrect, so this single command applies formatting once and detekt auto-corrections once (Gradle de-duplicates the shared tasks) — then verify cleanly with ./gradlew codeCheck.
.github/workflows/ci.yml runs on every PR:
build— JDK 21, Android SDK 36,./gradlew build, uploads the debug APK and publishes JUnit XML test resultslint— runscodeFormat(auto-commits formatting fixes), thencodeCheck(Spotless + Detekt)
.github/workflows/check-dependency-updates.yml runs weekly, executes the dependencyUpdates (ben-manes) task, and opens a GitHub issue if outdated dependencies are found.
Contributions are very welcome!
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature - Run
./gradlew spotlessApplyAll detektAllAutoCorrect codeFormatbefore committing (see Code Quality) - Commit using the project convention:
feat|fix|refactor|migrate|update: short description - Push and open a Pull Request against
develop
CI builds the project and runs Spotless/Detekt checks on every PR (see CI/CD).
These are the planned improvements currently in progress or on the roadmap:
- iOS target — the KMP foundation is in place across all non-
:appmodules (commonMain/androidMain/iosMain, with:feature:home/:network/:storagealso buildingiosX64). The next step is wiring up a SwiftUI host app and completing the remaining iOS-specific implementations. - Real test coverage — close the gap described in Testing Status: add
androidTestinstrumentation tests, exercise the already-declared Mockk/Turbine/MockWebServer dependencies, and populate the emptycommonTest/iosTestsource sets in:storage/:network. - Offline-first strategy — full read-from-cache-then-network flow using Room as the single source of truth, with explicit stale-data indicators in the UI.
- Widget support — a Glance-based home screen widget showing current temperature and conditions.
- Wear OS companion — lightweight Wear Compose screen for wrist-based weather glances.
- Release automation — CI already builds and lints every PR; the next step is automated release builds and Play Store internal track deployments.
- Accessibility pass — semantic descriptions, touch target sizing, and TalkBack compatibility audit.
- Dead code cleanup —
CitiesListRouteinRoutes.ktis no longer wired into navigation and can likely be removed.
This project intends to use the MIT License; a LICENSE file has not yet been added to the repository.