Skip to content

gerisztein/github-repos-poc

Repository files navigation

Build Status Commitizen friendly tested with jest jest

github-repos-poc

Vue App to consume Github's public API (POC)

TL;DR

You can run locally the project

$ yarn install
$ yarn dev

or visit the live demo.

Description

A basic app that displays trending repositories on Github. Initially it gets the repositories created since last week and sort them by stars.

You can also sort by Stars, Forks and Update date (ascending and descending) and filter by Programming Language. On the main results page, the programming language list is based on GitHub Octoverse 2017 and for starred repositories it's based on the results.

The functionality of starring repositories is just a simulation using localStorage as the login hasn't been implemented. The starred repositories can also be sorted and filtered.

The pagination has been partially implemented. It works using the URL query ?page=# but there's no visual component for it.

Install

To run locally, just type:

$ yarn install
$ yarn dev

To generate the build:

$ yarn install
$ yarn build

Live Demo

A live demo is available here.

https://gerisztein.github.io/github-repos-poc

Stack

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

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 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.

For more information, please refer to http://unlicense.org