Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.81 KB

README.md

File metadata and controls

63 lines (40 loc) · 2.81 KB
Raw

Welcome to PINGO (former code name: eClickr)

Licensed under the Eclipse Public License -v 1.0 (see LICENSE.txt).

originally made by Michael Whittaker / http://www.michael-whittaker.de

see http://pingo.upb.de/humans.txt for a contributor list.

This project was made for a university project with the Chair for Information management and E-Finance of the University of Paderborn. / http://www.upb.de/winfo2

Requirements

  • Ruby 1.9.3, RubyGems, Bundler (not tested with Windows or JRuby)

  • Gems: Bundler, for dependencies see Gemfile

  • MongoDB

  • Thin Webserver (recommended for high performance, not neccessary)

  • for Heroku: SimpleWorker account (optional, you can use Resque insted. Use of SimpleWorker is disabled by default.)

  • Juggernaut and Redis (optional, required for push support. Push support is enabled by default in production mode.)

Install / Run

  1. bundle install

  2. start MongoDB (see http://www.mongodb.org/display/DOCS/Quickstart) and create an user eclickr:eclickr for database eclickr: [on command-client:] mongo [ENTER] use eclickr [ENTER] db.addUser("eclickr", "eclickr") [ENTER] exit

  3. bundle exec rake db:seed (this will empty your MongoDB, be careful)

  4. bundle exec rails server or bundle exec foreman start (see Procfile for foreman setup)

  5. surf to http://localhost:3000/ (or http://localhost:5000/ if you used formeman) and login with [email protected] and Passwort "please". View from phone to see mobile view for participants.

  6. start Redis and Juggernaut and set URL in environments/development.rb (and restart server) for push support.

I18n

eClickr is localized with default Rails I18n. It uses a rack middleware to set the locale according to the viewer's browser. Files are in config/locaes/.

Configuration

You can configure most settings in the envireonments-files (i. e. config/environments/{development|production}.rb) and at config/initializers/*. The settings are split up because the environment on a developer's machine probably never is the same as the one for production (Caching, Juggernaut, Database, ...). The settings are named straight-forward and some are also commented.

Tests

Run bundle exec cucumber to run our integration tests (files at features/*).

More Infos