srobo / website

The Student Robotics public website
https://studentrobotics.org
Other
7 stars 13 forks source link

Student Robotics Website

Build status

The Student Robotics public website.

Getting Started

  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. (Optional) Install Node.js and npm.

    This allows spell checking to be run locally. Node is not required for the website to be built.

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

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

    $ gem install bundler rake
  5. Start the app in development mode

    $ rake dev

Making changes

When you've made a change, either push it to a forked repository, or to a feature branch, and raise a pull request.