Android MVVM Base Architecture for Populating NY Times Article using Architectural Components

Highlights

1. MVVM Architectural pattern
2. Offline Support
3. Unit test demonstration using JUnit
4. UI unit test demonstration using Espresso
5. Gradle scripts for running sonarqube static code analysis, code coverage, etc.

The application has been built with offline support. It has been designed using Android Architecture components with Room for offline data caching. The application is built in such a way that whenvever there is a service call, the result will be stored in local database.

The whole application is built based on the MVVM architectural pattern.

Application Architecture

The main advantage of using MVVM, there is no two way dependency between ViewModel and Model unlike MVP. Here the view can observe the datachanges in the viewmodel as we are using LiveData which is lifecycle aware. The viewmodel to view communication is achieved through observer pattern (basically observing the state changes of the data in the viewmodel).

Programming Practices Followed

a) Android Architectural Components
c) MVVM
d) Retrofit
f) JUnit for Unit testing
d) Repository pattern
e) Facade pattern

How to build ?

Open terminal and type the below command to generate debug build

./gradlew assembleDebug

Open terminal and type the below command to generate release build

./gradlew assembleRelease

How to generate code coverage report ?

Open terminal and type the following command

./gradlew clean jacocoTestReport

The coverage report will be generated on the following path.

app/build/reports