Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leereilly committed Apr 23, 2014
1 parent fcd1083 commit 72eae7d
Showing 1 changed file with 5 additions and 38 deletions.
43 changes: 5 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,14 @@
# OVERVIEW
![](http://i.imgur.com/aWmdUAK.png)

Github High Scores is a fun way to rank Github repository contributors in a 8-bit, 80's-tastic viewing environment.

## Installation

git clone git://github.com/leereilly/github-high-scores.git
rvm install ruby-1.8.7-p334 ## didn't have correct version
cd github-high-scores
gem install bundler
bundle
db_use=sqlite_default ruby app.rb

## Configuration

You can either use mysql, sqlite or sqlite with default setting

For mysql:

You'll need to set environment variables on your box. Locally, you can
set them in your .bash_profile...

export db_use=mysql
export db_user=some_username
export db_pass=some_password
export db_host=some_host
export db_data=some_database

On Heroku, you can do something like this...
This is a Ruby Sinatra app, so you'll need to know some Ruby-Fu to get it working locally.

heroku config:add db_user=XXX db_pass=XXX db_host=XXX db_data=XXX db_use=mysql

For sqlite:

export db_use=sqlite
export db_path=/some/absolute/path/to/my.db

For sqlite + default:

export db_use=sqlite_default

This then creates a my.db database file in db/

See app.rb for details.
git clone git://github.com/leereilly/github-high-scores.git
bundle install
ruby app.rb

## Contribute

Expand Down

0 comments on commit 72eae7d

Please sign in to comment.