KhaledSherifSayed / PopularPeople

A πŸ“± Popular People app using Shared Elements between fragments with transformation motions based on MVVM (ViewModel, Coroutines, LiveData, Repository, Koin) architecture.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Popular People πŸ‘“

GitHub license Android Weekly ktlint Github Followers GitHub forks GitHub watchers Twitter Follow

Popular People is a sample Android application πŸ“± showing stars of the world πŸ‘“ built to demonstrate use of Modern Android development tools. Dedicated to all Android Developers with ❀️.

You can Install and test latest Popular People app from below πŸ‘‡

Popular People App

About

It simply loads Popular People data from API.Peoples will be always loaded from Remote data (from API).

  • Clean and Simple Material UI.
  • Clean and Simple Architecture(MVVVM).
  • It will supports soon offline capable πŸ˜ƒ.

Dummy API is used in this app. JSON response is statically hosted here.

ScreenShots

Built With πŸ› 

  • SharedElements - Shared elemnts between fragments with Navigation Component.
  • Kotlin - First class and official programming language for Android development.
  • Coroutines - For asynchronous and more..
  • Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
    • LiveData - Data objects that notify views when the underlying database changes.
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
    • Room - SQLite object mapping library.
  • Dependency Injection -
    • Koin DI Version πŸ—‘οΈ
  • Retrofit - A type-safe HTTP client for Android and Java.
  • Moshi - A modern JSON library for Kotlin and Java.
  • Moshi Converter - A Converter which uses Moshi for serialization to and from JSON.
  • Glide - An image loading library for Android backed by Kotlin Coroutines.
  • Material Components for Android - Modular and customizable Material Design UI components for Android.
  • Gradle Kotlin DSL - For writing Gradle build scripts using Kotlin.

Unit Testing Frameworks

Unit Tests verify the interactions of viewmodels between repositories and dao & REST api requests.

  • Robolectric - Robolectric is the industry-standard unit testing framework for Android.
  • Mockito-Kotlin - a small library that provides helper functions to work with Mockito in Kotlin.

Contributed By: Khaled Sherif

Package Structure

com.meslmawy.ibtkarchallenge  # Root Package
.
β”œβ”€β”€ data                # For data handling.
β”‚   β”œβ”€β”€ remote          # Remote Data Handlers     
|   β”‚   β”œβ”€β”€ api         # Retrofit API for remote end point.
β”‚   └── repository      # Single source of data.
|
β”œβ”€β”€ model               # Model classes
    β”œβ”€β”€ dto             # Data Models         
β”œβ”€β”€ di                  # Dependency Injection             
β”‚   β”œβ”€β”€ builder         # Activity Builder
β”‚   β”œβ”€β”€ component       # DI Components       
β”‚   └── module          # DI Modules
|
β”œβ”€β”€ ui                  # Activity/View layer
β”‚   β”œβ”€β”€ base            # Base View
β”‚   β”œβ”€β”€ main            # Main Screen Activity & ViewModel
|   β”‚   β”œβ”€β”€Fragment     # Fragment
|   β”‚   └── viewmodel   # ViewModel for Main Fragmnet
β”‚   └── details         # Detail Screen Fragment and ViewModel
|   β”‚   β”œβ”€ Fragment     # Fragment
|   β”‚   └─ viewmodel    # ViewModel for Details Fragmnet 
β”‚   └── photo           # Photo Screen Fragment and ViewModel
|   β”‚   β”œβ”€ Fragment     # Fragment
|   β”‚   └─ viewmodel    # ViewModel for Details Fragmnet 
β”‚   β”œβ”€β”€ adapter         # Base Adapters Package
|   β”‚   β”œ  MainPopular  # Main adapter with ViewHolder for Popular People Items
|   β”‚   β”œ  Movies       # adapter with ViewHolder for Actor Movies
|   β”‚   └─ Images       # adapter with ViewHodler for Actor Images
└── utils               # Utility Classes / Kotlin extensions

Architecture

This app uses MVVM (Model View View-Model) architecture.

Soon 🎈πŸ’ͺ

  • Posters will be always loaded from local database. Remote data (from API) and Local data is always synchronized.
  • Try with Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.

Find this repository useful? ❀️

Support it by joining stargazers for this repository. ⭐
And follow me for my next creations! 🀩

License


Copyright (c) 2020 Khaled  Sherif
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 NON INFRINGEMENT. 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 πŸ“± Popular People app using Shared Elements between fragments with transformation motions based on MVVM (ViewModel, Coroutines, LiveData, Repository, Koin) architecture.

License:MIT License


Languages

Language:Kotlin 100.0%