Android Clean MVVM architecture

3rd-Party Libraries

• Used material for designing layouts and UI.

• Used viewmodel-ktx for keeping the state of fragments during configuration changes.

• Used StateFlow as a data holder for observing the screen's state changes.

• Used retrofit2 for networking and API calls.

• Used okhttp3 as a client agent and also defined interceptors.

• Used moshi-kotlin as a JSON parser and also defined custom adapters.

• Used coil for loading images.

• Used navigation for navigating through fragments.

• Used hilt for using dependency injection all over the app.

• Used kotlinx-coroutines for using the concurrency design pattern and doing asynchronous jobs.

• Used timber for logging within the app.

• Used junit for writing unit tests.

• Used truth for easy assertion in tests.

• Used mockk for mocking.

• Used turbine for testing flows.

• Used kotlinx-coroutines-test for testing coroutines.

• Used Kotlin-DSL for implementing Gradle configurations.

Architecture:

I decided to develop this app by using MVVM clean architecture. And here are my top 3 reasons for using it:

1. Low coupling: Build things in a distributed manner. It's all about the separation of concerns. You can also use multiple view models inside a single view.

2. Test Friendly: ViewModel has no reference to the View (Activity/Fragment) and can be tested easier than MVP for instance.

3. Understand the app easier: Domain layer tells you everything! what this app is all about and also what it can do for the user!

Modules:

• base: This module is responsible for keeping all settings and basic classes used in many modules.

• buildSrc: This module is responsible for holding all dependency definitions and Gradle configurations. It has been implemented all with Kotlin-DSL.

• common-ui: This module houses common UI components, such as the retry dialog, which are shared among ui features..

• data-android: Following the principle of separation between interfaces and their implementation, this module contains the implementation classes (remoteImpl and localImpl) for remote and local interfaces in the data layer.

• feature-news: this module holds all module related to news feature :

  • data-news: This module holds all classes and files, including service, APIs, RepositoryImpl, etc related to New data.

  • domain-news: I believe that the domain is the app's language; it speaks about all the services it provides. So you can find all use-cases used within the app here. Note that the UI and Data layers depend on this module according to clean architecture concepts.

  • ui-news: All the ui related to the News's user interface are accessible in this module.