forked from elovation/elovation
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
473c31e
commit 9246d09
Showing
2 changed files
with
43 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
Elovation | ||
=========================== | ||
|
||
[](https://travis-ci.org/drewolson/elovation) | ||
[](https://travis-ci.org/elovation/elovation) | ||
|
||
At Braintree, we play ping pong in the office. We wanted a way to track results and assign ratings to players. Elovation was born. It's a simple rails app that tracks the results of any two player game and assigns ratings to the players using the [Elo rating system](http://en.wikipedia.org/wiki/Elo_rating_system). | ||
|
||
This also supports individual player rankings within multi-player teams, using the [Trueskill ranking system](http://research.microsoft.com/en-us/projects/trueskill/) | ||
|
||
|
||
Deployment | ||
Quick Start with Heroku | ||
--------------------------- | ||
|
||
Elovation is optimized for deployment on [Heroku](http://www.heroku.com). Because the app doesn't provide any authentication or authorization, you can turn on basic auth by setting some environment variables in your heroku app. | ||
The fastest way to get started with Elovation is to click the deploy to [Heroku](http://www.heroku.com) button below. Elovation can be run on the free tier, so all you will require is a Heroku account to get started with no running costs. | ||
|
||
`heroku config:add BASIC_AUTH=true BASIC_AUTH_USER=username BASIC_AUTH_PASSWORD=password` | ||
[](https://heroku.com/deploy?template=https://github.com/elovation/elovation) | ||
|
||
After pushing the app to heroku, just run the migrations and you're all set. | ||
If you would like to add a level of authentication security to your app on Heroku, on the setup screen set the "BASIC_AUTH" to "true", and set a username and password in their respective fields. When you try to access your app in future, you will be prompted for your credentials. | ||
|
||
`heroku run rake db:migrate` | ||
The click to deploy button will automatically migrate your database. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"name": "Elovation", | ||
"description": "An open source Rails application for tracking multiplayer game scores", | ||
"repository": "https://github.com/elovation/elovation", | ||
"keywords": ["rails", "ruby"], | ||
"success_url": "/", | ||
"addons": ["heroku-postgresql:hobby-dev"], | ||
"env": { | ||
"RAILS_ENV": "production", | ||
"COOKIE_SECRET": { | ||
"description": "This gets generated", | ||
"generator": "secret" | ||
}, | ||
"SETUP_BY": { | ||
"description": "Who initiated this setup", | ||
"value": "", | ||
"required": false | ||
}, | ||
"BASIC_AUTH": { | ||
"description": "Would you like basic authentication? (true/false)", | ||
"value": "false" | ||
}, | ||
"BASIC_AUTH_USER": { | ||
"description": "If basic auth is enabled, set your username, otherwise leave blank", | ||
"value": "", | ||
"required": false | ||
}, | ||
"BASIC_AUTH_PASSWORD": { | ||
"description": "If basic auth is enabled, set your password, otherwise leave blank", | ||
"value": "", | ||
"required": false | ||
} | ||
}, | ||
"scripts": { | ||
"postdeploy": "bundle exec rake db:migrate" | ||
} | ||
} |