Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.64 KB

README.md

File metadata and controls

53 lines (35 loc) · 1.64 KB
Raw

Competition Website

This is the competition website for Student Robotics.

This includes the version of the homepage shown during the competition as well as the specific pages which the progress of the teams and matches at the competition.

Getting Started

Note: This website makes heavy use of the SR Competition API which is part of the separate SRComp suite. These instructions only contain information about these pages; it is assumed that the reader will configure an SRComp-HTTP instance separately.

  1. Clone this repo

  2. Install Ruby 3

    See .ruby_version for the precise version, though 3.3 or above will probably be fine.

  3. Install Bundler (2.3 or above) and Rake.

    Depending on how you have installed Ruby these may already be installed.

    $ gem install bundler rake

  4. Start the app in development mode

    $ rake dev

  5. View the site at http://localhost:4000/competition-website/comp/

Deployment

The site defined in this repo is deployed onto GitHub Pages (using GitHub Actions) and surfaced at https://studentrobotics.org/comp/.

During competition events the main page is also used as a takeover of our website homepage. This is toggled via enable_competition_homepage in our ansible config.