wburns84/loudoun_codes

A ruby on rails app to replace the PCSquared application used for HSPC coding contests.

README

This is an attempt to create an open-source, MIT-license-friendly, content runner for HSPC-style and similar coding contests.

This project was born as a project at RubyforGood 2017.

Contributors

• David Bock ([email protected], @bokmann), Team Lead
• Daniel P. Clark ([email protected], @danielpclark)
• Brandon Rice ([email protected], @brandonlrice)

(contributors, please add your information here.)

Getting Started

1. Install Ruby v2.4.1
2. Install (and start) Redis
3. mkdir -p /var/lib/milton - You must ensure that the user running the app has permissions in this directory.
4. Install Docker curl -fsSL https://get.docker.com/ | sh; sudo usermod -aG docker $(whoami)
5. Pull docker images rake docker
6. git clone https://github.com/rubyforgood/loudoun_codes.git
7. cd loudoun_codes
8. bundle install
9. bundle exec rake db:setup
10. bundle exec foreman start

If you are running the application for an actual competition, you probably want to use RAILS_ENV=production bundle exec foreman start in step 7.

After starting the application, you will see this line (or something similar) in your output:

14:25:13 web.1 | * Listening on tcp://0.0.0.0:5100

Browse to the provided address and you will see the web application. Browse to /sidekiq to see statistics about currently running jobs.

#Future Deployment

The 'getting started' instructions are above are while this project is in active development. A near-future goal of this project is to make deployment as brain-dead simple as possible. We may, for instance, wrap this code in a mini custom linux distribution so it could be put on a thumb drive and take over a machine for the purpose of the running content. We had previously considered a docker container mimicking the setup of the jenkins docker container, but considering our use of docker containers for the submission judging, we believe the inception scenario there would hurt our heads too much.