Sha256: 2adab80ad2491779bea906308051e8d05219075206861eec7e97c28f81739d27
Contents?: true
Size: 1.24 KB
Versions: 15
Compression:
Stored size: 1.24 KB
Contents
= Hubstats Github statistics This project rocks and uses MIT-LICENSE. = Authentication Hubstats needs github credentials to access your repos, these can be setup in one of two ways. == Environment Variables Hubstats uses OAUTH access tokens stored in ENV["GITHUB_API_TOKEN"] or for Application Authentication in ENV["CLIENT_ID"] and ENV["CLIENT_SECRET"] == octokit.yml Hubstats can also pull credentials from a YAML file stored in your app's config folder. Run rails generate hubstats:install from your app's directory to set it up. = Configuration Hubstats needs to know what repos for it to watch. You can set it to watch either an entire organization or a list of specific repos. These are set in octokit.yml, if you used environment variables for Authentication, you still must generate the octokit.yml using rails generate hubstats:install. = Setup Run rake hubstats:install:migrations Run rake hubstats:setup to run the necessary migrations and start pulling data from github. Add 'mount Hubstats::Engine => "/hubstats"' to your apps routes file =TL:DR -rails generate hubstats:install -add oauth tokens and repos to watch to octokit.yml -rake hubstats:install:migrations -rake hubstats:setup -Add 'mount Hubstats::Engine => "/hubstats"' to your routes file
Version data entries
15 entries across 15 versions & 1 rubygems