jedfoster / SassMeister

The Sass playground
http://sassmeister.com
198 stars 25 forks source link

`github.yml` missing #16

Closed lolmaus closed 11 years ago

lolmaus commented 11 years ago

Hi!

Trying to run SassMeister locally, it requires github.yml which is missing.

I hope you can check it in just like newrelic.yml — with some placeholder login/password.

jedfoster commented 11 years ago

Yeah, that file is a bit of a hack to work with the GitHub API. I haven't gotten around to refactoring it yet.

In the mean time, follow these directions to get it running locally: (excerpted from Roughdraft which uses the same pattern)


The GitHub API limits the number of unauthenticated requests to 60 per hour, which is too little for production and often even for development. To get around this you will need to register your app with GitHub. Once you have your client ID and secret, rename github.example.yml to github.yml and paste in your app's credentials. Mine looks something like this:

client_id: 9ef1xxxx
client_secret: 5784xxxxxxxx

You should now be able to submit up to 5000 requests per hour.

FAIR WARNING: Your client ID and secret should not be shared publicly. Do not commit github.yml to your repo, especially if you post your repo on GitHub. Read the instructions for configuring Heroku with your credentials, below.

# Restart Pow
touch tmp/restart.txt
# Rock and Roll

I know it's hacky.

lolmaus commented 11 years ago

Registering on GitHub OAuth requires providing the URL and Callback URL of my app. I'my trying the app locally in a VirtualBox VM, so my URL is http://localhost:3000 and i don't even know what Callback URL is.

Does this mean that i should obtain a Heroku instance to fiddle with SassMeister?

lolmaus commented 11 years ago

Yay, GitHub accepted dummy urls for an app and now rake server works, yay!

jedfoster commented 11 years ago

I merged your PR and added some instructions on setting up the github.yml file to the README file. I'm going to consider this closed unless you have anything to add?