The Omdb Android client illustrates how to write clean, testable and maintainable Android application.
- First, you need to request the omdb api key here
- Add the requested key to
./local.properties
omdb_api_key=<YOUR_OMDB_API_KEY>- Make sure to have java, gradle, Android SDK, etc, or simply install Android Studio
- Build the apk using command line
./gradlew :app:assembleDebug
- The apk is available at
./app/build/outputs/apk/debug/app-debug.apk
- Kotlin
- Coroutines
- Koin
- Retrofit
- Moshi
- Room
- Jetpack libraries
- Jetpack Compose
- Architecture components
- JUnit4
- Mockk
The architecture of the project follows the principles of Clean Architecture.
Each of the following layers will be implemented as a its own module in order to keep them separated in alignment with clean architecture and enable parallel builds in gradle.
Android UI components belong here. View communicates with ViewModel, subscribing to ViewState using StateFlow. Each View has a ViewModel attached that provides the data required by the view to make state transitions.
This module provides the logic of the View, by providing subscribing components to the view to react to. The ViewModel changes the ViewState based on the use case responses.
Contain use cases of the application. They provide the application specific business rules and are are responsible of accessing data from different repositories, combine and transform them, to provide single use case business rule.
The Data layer is our access point to external data layers and is used to fetch data from multiple sources (network, cache). It contains implementations of Repositories, which request data from necessary RemoteDataSources and CacheDataSources to feed the use case and make communication between the 2 types of data sources.
The Remote layer handles all communications with remote sources such as API calls using a Retrofit interface. A RemoteImpl class implements a Remote interface from the Data layer and uses a Service to retrieve data from the API.
The Cache layer handles all communication with the local databasea.
Run the following command in a terminal window at the root level of the project
./gradlew test