Awesome
MVVM Clean Architecture with RxJava3+Coroutines Flow, Static Code Analysis, Dagger Hilt, Dynamic Features
About
Sample project that build with MVVM clean architure and various cool techs including RxJava3 and Coroutines Flow, Dynamic Feature modules as base of BottomNavigationView or ViewPager2, with both OfflineFirst and OfflineLast approaches as database Single Source of Truth and TDD.
Unit tests are written with JUnit4, JUnit5, MockK, Truth, MockWebServer.
| Flow | RxJava3 | Pagination |
|---|---|---|
| <img src="./screenshots/property_flow.png"/> | <img src="./screenshots/property_rxjava3.png"/> | <img src="./screenshots/property_pagination.png"/> |
Overview
- Gradle Kotlin DSL is used for setting up gradle files with
buildSrcfolder and extensions. - KtLint, Detekt, and Git Hooks is used for checking, and formatting code and validating code before commits.
- Dagger Hilt, Dynamic Feature Modules with Navigation Components, ViewModel, Retrofit, Room, RxJava, Coroutines libraries adn dependencies are set up.
featuresandlibrariesfolders are used to include android libraries and dynamic feature modules- In core module dagger hilt dependencies and
@EntryPointis created - Data module uses Retrofit and Room to provide Local and Remote data sources
- Repository provides offline and remote fetch function with mapping and local save, delete and fetch functions
- Domain module uses useCase classes to implment business logic to fetch and forward data
- ViewModel uses LiveData with data-binding to display LOADING, and ERROR or SUCCESS states.
Built With ðŸ›
Some of the popular libraries and MVVM clean architecture used with offline-first and offline-last with Room database and Retrofit as data source
-
Kotlin - First class and official programming language for Android development.
-
Coroutines - Threads on steroids for Kotlin
-
Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
-
RxJava3 - Newest version of famous reactive programming library for Java, and other languages
-
Android JetPack - Collection of libraries that help you design robust, testable, and maintainable apps.
- LiveData - Data objects that notify views when the underlying database changes.
- ViewModel - Stores UI-related data that isn't destroyed on UI changes.
- DataBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
- Navigation Components Navigate fragments as never easier before
- Dynamic Feature Modules Dynamic modules for adding or removing based on preference
-
Material Components for Android - Modular and customizable Material Design UI components for Android.
-
- Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
- Hilt-ViewModel - DI for injecting
ViewModel.
-
Retrofit - A type-safe HTTP client for Android and Java.
-
Glide - Image loading library.
-
Lottie - animation library
-
Architecture
- Clean Architecture
- MVVM + MVI
- Offline first/last with Room an Retrofit
- Dynamic feature modules
-
Tests
- Unit Tests (JUnit5) (JUnit4)
- MockWebServer Mock server for testing Api requests with OkHttp and Retrofit
- Mockk Mockking library for Kotlin
- Truth Assertion library
-
Gradle
- Gradle Kotlin DSL
- Custom tasks
- Plugins (Ktlint, Detekt, SafeArgs), Git Hooks
Modularaization, Library and Feature Modules
Uses both library modules and dynamic feature modules
Architecture
<img src="./docs/android-final-architecture.png"/>Uses concepts of clean architecture