GitHub Search User Application

GitHub Search User is a sample Android application, built to demonstrate use of Modern Android development tools.

About

Using the application users can search GitHub users. Application loads data from GitHub API. The user gets the list of GitHub users after searching and then the user can tap on the GitHub user which opens the next screen where users can see all the public repositories and all the followers of that GitHub user. The application supports the lazy loading of Users, repositories, and followers, so users can have a seamless data loading experience. Implemented Lifecycle aware viewHolder for users list which respects the lifecycle of row's view components.

Built With

• Kotlin - First class and official programming language for Android development.
• Coroutines - For asynchronous operation.
• 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.
• Dependency Injection
  • Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
  • Hilt-ViewModel - DI for injecting ViewModel.
• Navigation - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app.
  • Safe args - Gradle plugin that provides type safety when navigating and passing data between destinations.
• Paging 3 - The Paging Library helps you load and display pages of data from a larger dataset from local storage or over the network.
• ViewPager 2 - ViewPager2 is an improved version of the ViewPager library.
• Retrofit - A type-safe HTTP client for Android and Java.
• Material Components for Android - Modular and customizable Material Design UI components for Android.
• Coil - An image loading library for Android backed by Kotlin Coroutines.

Architecture

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

The philosophy behind this architecture is to enable separation of concerns and ultimately a very modular application. This architecture was chosen because it provides the opportunity to separate concerns and implement "SOLID" principles which makes the application more robust and the code base scalable and maintainable.

This due separation of moving parts makes the app more testable with unit tests.

Quality

• LeakCanary - LeakCanary is a memory leak detection library for Android.
• StrictMode - StrictMode is a developer tool that detects things you might be doing by accident and brings them to your attention so you can fix them.
• Firebase Test Lab - Firebase Test Lab is a cloud-based app-testing infrastructure.

Static code analysis

Used Sonar Lint static code analysis.

Contact

If you need any help, you can connect with me.

Visit:- devmanishpatole.com

License

MIT License

Copyright (c) 2020 Manish Patole

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.