Introduction

HolidayChecker is Android app, aims to help people in long-distance relationships spend time together. For this, tan app shows couples when they can meet on public holidays.

Prerequisites

Here are the prerequisites for running the sdk and example app in development and production:

1. Install Android Studio 4.1+.
2. JDK: A copy of the latest OpenJDK comes bundled with Android Studio. Separate JDK can be used as well. See documentation for more details.

Structure

This repo contains app and buildScr projects:

• app - Android app, which loads reviews as user scrolls and display review details on click.
• buildScr - centralizes dependencies management of libs and plugins, which are used by the app.

Project set-up

Key facts about project set-up and architecture:

1. Gradle build is written in Kotlin DSL.
2. Project follows Clean Architecture principles: e.g. business logic is separated from implementation details of network or db layer, etc.
3. Project uses MVVM pattern in order to separate UI logic from app business logic: e.g. UI layer (Fragment) observes and renders data from view model using Kotlin Flow and Jetpack's ViewModel.
4. Networking is implemented using Retrofit.
5. Dependency Injection is implemented using Hilt.
6. Asynchronous operations are implemented off UI thread using Kotlin Coroutines.
7. In-app navigation to be implemented using Navigation component.

Unit tests are implemented using:

• MockK
• Kotlin power assert
• JUnit 5
• Kotlin test