Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mayorJAY/HolidayInfo

A multi-module offline-first Android Application that lists the various holidays observed in different Countries and different Years
https://github.com/mayorJAY/HolidayInfo

coroutines hilt-dependency-injection kotlin multi-module mvvm mvvm-android offline-first repository-pattern restful retrofit room room-persistence-library solid-principles

Last synced: 2 months ago
JSON representation

A multi-module offline-first Android Application that lists the various holidays observed in different Countries and different Years

Awesome Lists containing this project

README 

        


  




# HolidayInfo



HolidayInfo is an offline-first Android Application that fetches and displays the various holidays observed in different Countries and different years. The App fetches the data from [Nager.Date API](https://date.nager.at/Api) and uses Room for offline caching. It has a Splash Screen, a Home page showing a list of Countries and a Holiday details page which is displayed when a country and year is selected. It is implemented using Multi-module, Clean Architecture, Model-View-ViewModel (MVVM) pattern and uses Modern Android Development pattern and libraries. Adequate Unit Tests were also implemented in the codebase.



## Project Characteristics



This application has the following characteristics:

* 100% Kotlin

* Modern Architecture (Clean Architecture, Model-View-ViewModel)

* [Android Jetpack Components](https://developer.android.com/jetpack)

* [Material Design](https://material.io/develop/android/docs/getting-started)



## Tech Stack



Minimum API level is set to 21, this means HolidayInfo can run on approximately 98% of Android devices

* [Splash Screen](https://developer.android.com/develop/ui/views/launch/splash-screen), the standard recommended Splash Screen library for Android Applications

* [Retrofit](https://square.github.io/retrofit/) which is a type-safe REST client for Android which makes it easier to consume RESTful web services

* [Moshi](https://github.com/square/moshi), a modern JSON library for Android, Java and Kotlin

* [OkHttp Logging Interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor), an OkHttp interceptor which logs HTTP request and response data

* [Kotlin Coroutines](https://developer.android.com/kotlin/coroutines) used to perform asynchronous network calls to the remote server

* [Room](https://developer.android.com/training/data-storage/room), a persistence library with an abstraction layer over SQLite for database manipulation

* [Hilt](https://dagger.dev/hilt/), a DI library for Android that reduces the boilerplate of using manual DI

* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) used to store and manage UI-related data in a lifecycle conscious way

* [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) which is an observable data holder class used to handle data in a lifecycle-aware manner

* [View Binding](https://developer.android.com/topic/libraries/view-binding) used to easily write code that interacts with views by referencing them directly

* [Kotlin flow](https://developer.android.com/kotlin/flow) for emitting live updates from a network call sequentially

* [Material Design](https://material.io/develop/android/docs/getting-started/) which is an adaptable system that guides in maintaining principles and best practices of contemporary UI

* [Timber](https://github.com/JakeWharton/timber), a utility library for logging and easy debugging

* [SearchableSpinner](https://github.com/miteshpithadiya/SearchableSpinner), a dialog spinner with a search feature which allows users to search the items loaded in the spinner

* [SDP/SSP](https://github.com/intuit/sdp) which is a scalable size unit that scales with the screen size. It helps to easily design for multiple screens

* [JUnit4](https://junit.org/junit4), a testing framework used for writing unit tests

* [MockWebServer](https://javadoc.io/doc/com.squareup.okhttp3/mockwebserver/3.14.9/overview-summary.html), a library that makes it easy to test how Apps behave when making HTTP/HTTPS calls

* [Mockito](https://site.mockito.org/), a mocking framework for writing unit tests



## Installation



Get the [APK here](https://github.com/mayorJAY/HolidayInfo/blob/master/media/HolidayInfo.apk) and stay informed about holidays observed around the world :beach_umbrella: :airplane: