Skip to content

gerin98/androidGitClient

Repository files navigation

license download

Android Git Client

Search and Browse through GitHub repos with this helpful android app. Powered by the GitHub REST API, you can find any public repo hosted on GitHub!

Table of Contents

1. Main Features
2. Getting Started
3. Api
4. Tech Stack
5. License

Main Features 💡

Dark Mode 🌓

Supports both light and dark themes.

Search 🔍

Search by GitHub username to obtain all of their public repos.

Sorting 📂

Sort results by alphabetical, most starred or most forked.

Getting Started 🚀

Clone this repo to play with it yourself.

git clone https://github.com/gerin98/androidGitClient.git

You can also download the APK directly here.

Api 📰

This project makes use of the Github's API to query for users and repos.

Tech Stack 🛠️

  • Language
    • Kotlin - First class and official programming language for Android development.
  • Architecture
    • MVVM & Repository pattern - separate ui logic from business logic.
    • LiveData - an observable lifecycle-aware data holder class.
    • RxJava - a library for composing asynchronous and event-based programs by using observable sequences.
    • ViewBinding - easily write code that interacts with views.
  • Network
    • Retrofit - A type-safe HTTP client for Android and Java.
  • UI
    • Databinding - bind UI components in your layouts to data sources in your app.
    • Material Design - a visual language that synthesizes the classic principles of good design with the innovation of technology and science.
    • Icons - delightful, beautifully crafted symbols for common actions and items.
  • Image loading
    • Glide - An image loading and caching library for Android focused on smooth scrolling.

License

MIT License

Copyright (c) 2020 Gerin Amalaraj

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.