No description, website, or topics provided.
Ruby JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Controllers
CouchApp
Library
Models
Pool Scoring.esproj
Public
Templates
Views
.gitignore
.yardopts
Gemfile
Gemfile.lock
README.md
config.ru
pool-scoring.rb

README.md

Pool Scoring

This is a very simple web app used to keep track of pool scores within an organization.

Running Locally

Requirements

To run the app locally, you need the following:

  • Ruby (ideally 1.9.2)
  • Bundler. Install with gem install bundler
  • Shotgun. Install with gem install shotgun
  • CouchDB. Install with brew install couchdb
  • CouchApp. Install using Installing CouchApp

Setup

Clone this repository onto your local machine.

From the root of the application, run the following to install all gem dependencies:

$ bundle install

To set up CouchDB, you need a database and a user named poolscoring. The user's password should be yourmum. To create the design documents, change into the CouchApp directory, and perform the following commands:

$ couchapp push Game http://poolscoring:yourmum@localhost:5984/poolscoring
$ couchapp push Person http://poolscoring:yourmum@localhost:5984/poolscoring

Double check that the design documents are present from within Futon.

Running

Start the app by running the following from the root of the application:

$ shotgun -p4567 config.ru

You can access your local clone now at http://localhost:4567/. Enjoy!

Documentation

Generate documentation by running:

$ yarddoc

which may require you to install YARD:

$ gem install yard
$ gem install redcarpet