alirezaeiii / SimpleGame-Navigation

A sample to showcase Kotlin, Navigation, Dagger, RxJava, Retrofit, DataBinding, Espresso and Unit test.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SimpleGame-Navigation

A sample to showcase Kotlin, Navigation, Dagger, RxJava, Retrofit, DataBinding, Espresso and Unit test.

Features

  • Clean Architecture + Repository design Pattern.
  • Jetpack Libraries and Architecture Components.

Prerequisites

Add your Giphy API key in the local.properties file:

giphy_api_key=YOUR_API_KEY

Testing

Local unit testing is done for Repository, UseCase and ViewModel layers.

Libraries

  • Android Jetpack
    • ViewModel ViewModel is designed to store and manage UI-related data in a lifecycle conscious way. This allows data to survive configuration changes such as screen rotations.
    • DataBinding is a Library in the support library that allows you to bind UI components in your layouts to data sources in your app using a declarative format rather than programmatically.
    • LiveData is lifecycle-aware, meaning it respects the lifecycle of other app components updating app component observers that are in an active lifecycle state.
    • Navigation Android Jetpack's Navigation component helps you implement effective navigation.
  • Glide is an image loading and caching library for Android.
  • Dagger is a fully static, compile-time dependency injection framework for Java, Kotlin, and Android.
  • RxJava is a library for composing asynchronous code using observable sequences.
  • RxAndroid is a module that adds the minimum classes to RxJava to make writing reactive components in Android.
  • Retrofit is a Type-safe HTTP client for Android, Java and Kotlin by Square.
  • Moshi is a modern JSON library for Android and Java. It makes it easy to parse JSON format data.
  • OkHttp interceptor Logs HTTP requests and responses.
  • Material Design Build beautiful, usable products using Material Components for Android.
  • Commons Lang The standard Java libraries fail to provide enough methods for manipulation of its core classes. Apache Commons Lang provides these extra methods.
  • Mockito which is the most popular Mocking framework for unit tests written in Java as well as Kotlin.
  • Espresso Automated testing UI test

Licence

MIT License

Copyright (c) 2021 Mohammadali Rezaei

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

A sample to showcase Kotlin, Navigation, Dagger, RxJava, Retrofit, DataBinding, Espresso and Unit test.


Languages

Language:Kotlin 100.0%