Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KhaledSherifSayed/PopularPeople
A π± Popular People app using Shared Elements between fragments with transformation motions based on MVVM (ViewModel, Coroutines, LiveData, Repository, Koin) architecture.
https://github.com/KhaledSherifSayed/PopularPeople
Last synced: 3 months ago
JSON representation
A π± Popular People app using Shared Elements between fragments with transformation motions based on MVVM (ViewModel, Coroutines, LiveData, Repository, Koin) architecture.
- Host: GitHub
- URL: https://github.com/KhaledSherifSayed/PopularPeople
- Owner: KhaledSherifSayed
- License: mit
- Created: 2020-07-08T14:35:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-11T18:47:54.000Z (over 4 years ago)
- Last Synced: 2024-07-15T22:52:20.877Z (4 months ago)
- Language: Kotlin
- Homepage:
- Size: 67.4 MB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-android-kotlin-apps - PopularPeople
README
# Popular People π
[![GitHub license](https://img.shields.io/badge/License-Khaled-blue.svg)](LICENSE.txt)
[![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23406-2CA3E6.svg?style=flat)](http://androidweekly.net/issues/issue-406)
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
![Github Followers](https://img.shields.io/github/followers/KhaledSherifSayed?label=Follow&style=social)
![GitHub forks](https://img.shields.io/github/forks/KhaledSherifSayed/PopularPeople?style=social)
![GitHub watchers](https://img.shields.io/github/watchers/KhaledSherifSayed/PopularPeople?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/Meslmawy?label=Follow&style=social)**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](https://img.shields.io/badge/Popularπ-APK-red.svg?style=for-the-badge&logo=android)](https://github.com/KhaledSherifSayed/PopularPeople/releases/latest/download/popular_people.apk)
## 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](https://developers.themoviedb.org/3)*.
## ScreenShots
## Built With π
- [SharedElements](https://developer.android.com/training/transitions/start-activity) - Shared elemnts between fragments with Navigation Component.
- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For asynchronous and more..
- [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
- [ViewBinding](https://developer.android.com/topic/libraries/view-binding) - 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](https://developer.android.com/topic/libraries/architecture/room) - SQLite object mapping library.
- [Dependency Injection](https://developer.android.com/training/dependency-injection) -
- [`Koin`](https://insert-koin.io/) DI Version π‘οΈ
- [Retrofit](https://square.github.io/retrofit/) - A type-safe HTTP client for Android and Java.
- [Moshi](https://github.com/square/moshi) - A modern JSON library for Kotlin and Java.
- [Moshi Converter](https://github.com/square/retrofit/tree/master/retrofit-converters/moshi) - A Converter which uses Moshi for serialization to and from JSON.
- [Glide](https://github.com/bumptech/glide) - An image loading library for Android backed by Kotlin Coroutines.
- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.
- [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html) - 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](https://github.com/robolectric/robolectric) - Robolectric is the industry-standard unit testing framework for Android.
- [Mockito-Kotlin](https://github.com/nhaarman/mockito-kotlin) - a small library that provides helper functions to work with Mockito in Kotlin.
**Contributed By:** [Khaled Sherif](https://github.com/KhaledSherifSayed)
# 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)***](https://developer.android.com/jetpack/docs/guide#recommended-app-arch) architecture.![](https://developer.android.com/topic/libraries/architecture/images/final-architecture.png)
## Soon ππͺ
- Posters will be always loaded from local database. Remote data (from API) and Local data is always synchronized.
- Try with [Hilt-Dagger](https://dagger.dev/hilt/) - Standard library to incorporate Dagger dependency injection into an Android application.
## Find this repository useful? :heart:
Support it by joining __[stargazers](https://github.com/KhaledSherifSayed/PopularPeople/stargazers)__ for this repository. :star:
And __[follow](https://github.com/KhaledSherifSayed)__ 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```