Skip to content

Commit

Permalink
polish readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geraldb committed Jul 15, 2012
1 parent 2cb34a0 commit 469835c
Showing 1 changed file with 52 additions and 19 deletions.
71 changes: 52 additions & 19 deletions README.markdown
Expand Up @@ -4,46 +4,79 @@ A free, open source sports betting pool in Ruby on Rails (version 3.2 and up).

Example events include:

* UEFA Champions League 2012
* UEFA Europa League 2012
* Österreichische Bundesliga 2012
* ÖFB Cup 2012
* UEFA European Football Championship aka Euro 2012
* National Hockey League (NHL) 2012 (in progress)
* [UEFA Champions League 2012](https://github.com/geraldb/wettpool/tree/master/db/seeds/cl)
* [UEFA Europa League 2012](https://github.com/geraldb/wettpool/tree/master/db/seeds/cl)
* [Österreichische Bundesliga 2011/12, 2012/13](https://github.com/geraldb/wettpool/tree/master/db/seeds/austria)
* [ÖFB Cup 2011/12, 2012/13](https://github.com/geraldb/wettpool/tree/master/db/seeds/austria)
* [UEFA European Football Championship aka Euro 2012](https://github.com/geraldb/wettpool/tree/master/db/seeds/euro)
* [Romania Liga 1 2012/13](https://github.com/geraldb/wettpool/tree/master/db/seeds/romania)
* [México Primera División Apertura 2012](https://github.com/geraldb/wettpool/tree/master/db/seeds/mexico)
* [World Cup Quali 2012/13](https://github.com/geraldb/wettpool/tree/master/db/seeds/world)
* [National Hockey League (NHL) 2012](https://github.com/geraldb/wettpool/tree/master/db/seeds/nhl)


## Demo

Try the demo install running on Heroku [wettpool.herokuapp.com](http://wettpool.herokuapp.com).
Try the demo install running on Heroku [`wettpool.herokuapp.com`](http://wettpool.herokuapp.com).

Use the login credentials demo/demo.
Use the login credentials `demo`/`demo`.


## Setup on Heroku
## Setup

Clone the Wettpool git repo
### Setup on your local machine

Clone the Wettpol git repo:

git clone git://github.com/geraldb/wettpool.git

Get all your Ruby libraries (gems) installed using the bundler tool:

cd wettpool
bundle install --without production

Note, use the `--without production` option for local development
unless you want to install the PostgreSQL (pg) database libraries and services
(required for production on the Heroku hosting service.)

Setup the database and seeds:

rake db:setup

Showtime! Startup the server and use the `demo`/`demo` credentials to sign in:

rails server

That's it.


### Setup on Heroku

Clone the Wettpool git repo:

git clone git://github.com/geraldb/wettpool.git

git clone ???

Create app on Heroku e.g.

heroku create <your_app_name_here> --cedar ???
cd wettpool
heroku create <your_app_name_here>

Upload via

git push heroku

Create DB on first upload via

heroku run rake db:migrate db:seed

or all-in-one alternative

heroku run rake db:setup

That's it.
Showtime! Sign in using the `demo`/`demo` credentials. That's it.


## License

The wettpool scripts and templates are dedicated to the public domain.
Use it as you please with no restrictions whatsoever.
Use it as you please with no restrictions whatsoever.

## Questions? Comments?

Send them along to the [Wettpool Forum/Mailing List](http://groups.google.com/group/wettpool). Thanks!

0 comments on commit 469835c

Please sign in to comment.