MVVM-Kotlin-Android-Base

MVVM-Kotlin-Android-Base copied to clipboard

MVVM-Kotlin-Android-Base

This App is common Modules and libraries i use in my apps, i decided to make it open source :)

• you can use it as a base for your new app.
• All contributions are welcome.

Languages, libraries and tools used

• Kotlin
• androidX libraries
• Android LifeCycle
• dagger2
• kotlinx.coroutines
• Retrofit2
• Glide
• Room
• Timber
• [DataBinding]

Requirements

• min SDK 21

Implementation

• In this project I'm using MVVM Pattern as an application architecture with these design patterns in mind:-

• Repository Pattern
• Singleton
• Factory
• Adapters

• Using Dagger2 for dependency injection that will make testing easier and our make code cleaner and more readable and handy when creating dependecies.
• Using Retrofit library to handle the APIs stuff.
• [Creating Custom ImagesLoader] with Glide to load it into ImageView with no pain of writting a lot of code when load images
• Using Coroutines for managing background threads that can simplify code by reducing the need for callbacks and convert async callbacks for long-running tasks, such as database or network access, into sequential code and can automatically manage the life cycle.
• Separation of concerns : The most important principle used in this project to avoid many lifecycle-related problems.
• Each component depends only on the component one level below it. For example, activities and fragments depend only on a view model. The repository is the only class that depends on multiple other classes; in this example, the repository depends on a persistent data model and a remote backend data source.
• Using to best of managing ViewState with less complex tools.

ViewModel LifeCycle

The ViewModel should outlive the View on configuration changes. For instance, on rotation, the Activity gets destroyed and recreated but your ViewModel should not be affected by this. If the ViewModel was to be recreated as well, all the ongoing tasks and cached latest ViewState would be lost. We use the Architecture Components library to instantiate our ViewModel in order to easily have its lifecycle correctly managed.

##Contributing For new features, please open an issue to discuss it before beginning implementation.

##For any question

• you can contact me on my email: [email protected]