/gh-info

Get info about your repo.

Primary LanguageHTML

gh-info

An example single page application, using the Github API. Less than feature complete, but easily extendable/modifiable.

Libraries

This application uses the following libraries:

  • Routie - A simple Javascript hash router.
  • doT - A small but advanced template system. Used for generating the views.

Usage

This application uses the following url formats:

  • ~ #repo/OWNER/REPO/commits/
  • ~ #repo/OWNER/REPO/commits/author=isaacrg

Parameters can be applied to a particular page, eg. #repo/isaacrg/gh-info/commits/author=isaacrg&per_page=2 - these parameters match the GET query parameters of the relevant Github API options. Note also that the developer consoles in browser can give you an insight into what is going on behind the scenes, in terms of network requests.

The example pages in the "old" folder demonstrate how this project could be done with being physically separate, but the result is too slow. The folder remains to showcase a similar technique to gh-edit

Note: Due to Github API rate limiting, you could use up your days worth of the Github API rate limit. If you do encounter this problem Generate a personal access token, and then access http://isaacrg.github.io/gh-info/?ACCESS-TOKEN-HERE#repo/isaacrg/repo-info/home, and then modify the hash part of the url as appropriate. Using this access token method, you can also view information about private repositories you have access to.

Remember not to give your personal access token to anyone else, as this could grant them access to confidential or private repos and other data.