waheednazir/kotlin-mvvm-architecture

Android Architecture Design Patterns using Kotlin, MVVM, Hilt, LiveData, Room, MediatorLiveData, NetworkBoundResources, Retrofit, AndroidX, ViewModels, Dependency Injection using Dagger2, Repository pattern.

Kotlin MVVM Architecture

A sample app that display list of Google news. The purpose of this project to illustrate the usage of MVVM architecture design pattern that follow the best practices of Object Oriented Design Patterns using the following technology stack.

1. Architecture Design Pattern
2. MVVM
3. Dagger2 (Dependency Injection)
4. Live Data, MediatorLiveData
5. Room Database
6. Retrofit
7. Unit Testing (Espresso), Mockito (Coming soon)
8. Repository Pattern
9. AndroidX
10. Glide
11. NetworkBoundResource, NetworkAndDBBoundResource
12. Google News API
13. JetPack Libraries

Demo

Architecture

NetworkBoundResource

Mediator LiveData

Other samples of MVVM using Kotlin

• View-ViewModel-Interaction - Sample shows View and ViewModel Interaction/Communication.
• Communication-ActivityFragment-ViewModel - Sample shows communication between Activity and Fragment using ViewModel
• ViewModel-ViewModel-Communication - Sample shows communication between ViewModels
• LocationUpdates-LiveData-ViewModel - Sample shows, to get location updates as LiveData in Kotlin.
• Kotlin-MVVM-Architecture - Sample of complete MVVM Architecture using Dagger2, Kotlin, MediatorLiveData, Retrofit etc.
• Presentation Slides - Presentation slides on this architecture sample.

Author

Waheed Nazir

Sources

1. Google's official doc
2. Google's Codelab
3. Architecture Components Samples
4. Jose Alcérreca's post at Medium

---

If you want to support this repo, you can buy the developer a coffee. More information at: buy-me-a-coffee

---

kotlin-mvvm-architecture's Issues

PreferencesModule sample

Hello.

I have read your mvvm architecure i.e. very good. can you please provide how to use sharedPreference in your sample

@Module
class PreferencesModule {
   /**
     * Provides Preferences object with MODE_PRIVATE
     */
    @Provides
    @Singleton
    fun provideSharedPreference(app: Application):
            SharedPreferences = app.getSharedPreferences("SharedPreferences", Context.MODE_PRIVATE)

}

Where i can find Unit test cases

How to add interceptor in retrofit in this project

I want to refresh my token when it expires, for that I need to change in everycall and need to add login method in every Repo. for that I have studied that interceptor can fix it. please explain how to add this into it.