This is an Implementation RecyclerView using Retrofit and Gson to Create a simple app that lists the most starred Github repositories that were created in the last 30 days.
JSON Data is being fetched directly from the Github API(read more about Github API here)
Features :
- listing the most starred Github repos that were created in the last 30 days.
- listing One repository per row.
- Diplaying the following details of each repository row :
- Repository name
- Repository description
- Numbers of stars for the repo.
- Username and avatar of the owner.
- Pagination to show more data when Scrolling down
Getting data from the server using Github API :
- Retrofit : Retrofit is a type-safe REST client for Android (or just Java) developed by Square. The library provides a powerful framework for authenticating and interacting with APIs and sending network requests with OkHttp. See this guide to understand how OkHttp works.
This library makes downloading JSON or XML data from a web API fairly straightforward. Once the data is downloaded then it is parsed into a Plain Old Java Object (POJO) which must be defined for each "resource" in the response.
- Gson : This is a Java library that can be used to convert Java Objects into their JSON representation. It can also be used to convert a JSON string to an equivalent Java object. Gson can work with arbitrary Java objects including pre-existing objects that you do not have source-code of.
- We are using RecyclerView to Display data, this component is more powerfull then a ListView
In this app, we are getting the most starred Github repos created in the last 30 days (relative to 2017-11-22)
using this endpoint:
https://api.github.com/search/repositories?q=created:>2017-10-22&sort=stars&order=desc
This is how the result looks like :
Rows structure is being like bellow :
]()
The JSON data from Github is be paginated (30 repos per Json page)
To get the 2nd page, we add &page=2 to the end of the API request like bellow :
https://api.github.com/search/repositories?q=created:>2017-10-22&sort=stars&order=desc&page=2
Using Retrofit Library, it is easy to do that by adding the 'page' parameter to the QueryMap like bellow :
currentPage is an incrementing variable according to every load
Please clone the repository's link to your android studio like bellow :
Copyright (c) 2018 Nisrine Zbadi
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.