-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'feature/refactoring' into develop
- Loading branch information
Showing
24 changed files
with
483 additions
and
304 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# MVVM Clean Architecture with RxJava3+Coroutines Flow, Static Code Analysis, Dagger Hilt, Dynamic Features | ||
|
||
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/) | ||
[![Kotlin Version](https://img.shields.io/badge/kotlin-1.4.0-blue.svg)](https://kotlinlang.org) | ||
[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21) | ||
|
||
## 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 | Favorites | ||
| ------------------|-------------| -----|--------------| | ||
| <img src="./screenshots/property_flow.png"/> | <img src="./screenshots/property_rxjava3.png"/> | <img src="./screenshots/property_pagination.png"/> |<img src="./screenshots/favorites.png"/> | | ||
|
||
|
||
## Overview | ||
* Gradle Kotlin DSL is used for setting up gradle files with ```buildSrc``` folder 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. | ||
* ```features``` and ```libraries``` folders are used to include android libraries and dynamic feature modules | ||
* In core module dagger hilt dependencies and ```@EntryPoint``` is 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 | ||
* Pagination with database | ||
|
||
## 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](https://kotlinlang.org/) - First class and official programming language for Android development. | ||
|
||
* [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - Threads on steroids for Kotlin | ||
* [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception. | ||
* [RxJava3](https://github.com/ReactiveX/RxJava) - Newest version of famous reactive programming library for Java, and other languages | ||
* [Android JetPack](https://developer.android.com/jetpack) - Collection of libraries that help you design robust, testable, and maintainable apps. | ||
* [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes. | ||
* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes. | ||
* [DataBinding](https://developer.android.com/topic/libraries/data-binding) - 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](https://developer.android.com/guide/navigation/navigation-getting-started) Navigate fragments as never easier before | ||
* [Dynamic Feature Modules](https://developer.android.com/guide/playcore/dynamic-delivery) Dynamic modules for adding or removing based on preference | ||
* [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android. | ||
* [Dependency Injection](https://developer.android.com/training/dependency-injection) - | ||
* [Hilt-Dagger](https://dagger.dev/hilt/) - Standard library to incorporate Dagger dependency injection into an Android application. | ||
* [Hilt-ViewModel](https://developer.android.com/training/dependency-injection/hilt-jetpack) - DI for injecting `ViewModel`. | ||
* [Retrofit](https://square.github.io/retrofit/) - A type-safe HTTP client for Android and Java. | ||
* [Glide](https://github.com/bumptech/glide) - Image loading library. | ||
* [Lottie](http://airbnb.io/lottie) - animation library | ||
|
||
* Architecture | ||
* Clean Architecture | ||
* MVVM + MVI | ||
* Offline first/last with Room an Retrofit | ||
* [Dynamic feature modules](https://developer.android.com/studio/projects/dynamic-delivery) | ||
* Tests | ||
* [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) ([JUnit](https://junit.org/junit4/)) | ||
* [Mockk](https://mockk.io/) | ||
* | ||
* Gradle | ||
* [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html) | ||
* Custom tasks | ||
* Plugins ([Ktlint](https://github.com/JLLeitschuh/ktlint-gradle), [Detekt](https://github.com/arturbosch/detekt#with-gradle), [SafeArgs](https://developer.android.com/guide/navigation/navigation-pass-data#Safe-args)) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.