Github Readme Viewer

Note: This application only makes unauthenticated calls to the Github API, so it is prone to aggressive rate limiting.

Live demo

https://github-readme-viewer.surge.sh

Getting started

Requirements

• >= Node 10
• yarn

To get the project running locally:

1. Clone this repository

$ git clone [email protected]:kyleoliveiro/github-readme-viewer.git
$ cd github-readme-viewer

2. Install project dependencies

$ yarn

3. Serve the project

$ yarn serve

Generating a production build

Run yarn build to generate a production build.