README.md

Pair Program With Me - Matcher

A sinatra app with github auth for Avdi

• see ppwm, a ppwm scraper, and rubypair

TODO

• a way to view created codes
• add a mailto: link to user emails
• fix deprecation warnings from github auth
• don't let codes be re-used by other users
• require an email address if not submitted
• make a get '/code' route behave nicely, or otherwise improve UX
  • e.g. Right now, you can only check if your pair has signed in by submitting your code via post
• move view code out of the app.rb
• anything else you can think of:
  • security
  • gravatars for fun
  • design
  • letting you know when your 'pair' signed in
  • letting an admin view a list of paired users and codes
  • maybe leave messages for avdi in some queue...
  • add admin links (need to create an admin user, user roles) e.g. to create codes etc
  • UX
  • analytics?

Setup

You'll want to have two github applications, one for development, and one for production.

For each app, Make a note of the client ID and secret.

For production, enter your application URL http://<domain>/ and set the callback URL should be http://<domain>/auth/github/callback.

For development, set your application URL to http://localhost/ and set your callback URL to http://localhost:9393/auth/github/callback

For development

Install the gems:

bundle

Then set up your the application config and database settings

./serve.sh setup

Update the GITHUB keys in your config/application.yml

Finally start the web server using thin:

./serve.sh start

If you want to daemonize your dev server

./serve.sh start -d
./serve.sh stop

Deploying to heroku (production)

heroku addons:add heroku-postgresql:dev
heroku config:set GITHUB_CLIENT_ID="<from GH>" GITHUB_CLIENT_SECRET="<from GH>"
git push heroku master
heroku run rake db:migrate

License

Ask Avdi