Skip to content
This repository has been archived by the owner on Aug 1, 2022. It is now read-only.
/ github-app Public archive

A simple Github API MVVM beginner android project

License

Notifications You must be signed in to change notification settings

rekyb/github-app

Repository files navigation

Jyro

License API API API

Just another Github API beginner android project which utilize MVVM architecture and modern Android tech-stacks. Searching data through Github API end-points, then store some data with Room Database (favourite or bookmarking feature). It also provide dark or light theme that can be stored to Data Store preferences.

Screenshots

Tech-stacks and Libraries

  • Full written in Kotlin
  • Coroutines, Flow, and Live Data
  • Jetpack libraries:
    • Hilt
    • Room
    • DataStore
    • DataBinding
    • Lifecycles
    • Preferences
    • Navigation components
    • Cardview
    • Recyclerview
    • ConstraintLayout
    • CoordinatorLayout
    • ViewPager2
  • Material designs
  • Retrofit and Okhttp
  • Coil-Kt image loading and processing
  • FancyToast
  • Timber
  • Spotless

How-to

  1. You need to generate a personal access token. Go to Github Docs for more informations
  2. In your gradle.properties file, add this line:
```
GithubApiKey=token your_personal_access_token
```
  1. Change the value with your personal access token
  2. If the gradle.properties doesn't exists, just create a new one.

Contacts

I'm available at Discord: rekyb#3481.

License

MIT License

Copyright (c) 2021 Rekyb

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.