worldcubeassociation.org

This repository contains all of the code that runs on worldcubeassociation.org.

Setup

• Clone this repo! (And navigate into it)

  git clone https://github.com/thewca/worldcubeassociation.org
  cd worldcubeassociation.org
  

• Ensure you have the correct Ruby version installed. We recommend using a Ruby version manager like rvm or rbenv. They should both read the .ruby-version file to use the correct version (rvm current or rbenv version to confirm).
• Ensure Bundler 2 is installed
  • To update from bundler 1:

    gem update --system
    bundle update --bundler
    

  • Or, if you haven't installed bundler previously:

    gem update --system
    gem install bundler
    

• Set up git pre-commit hook. Optional, but very useful.

  (cd WcaOnRails; bundle install && bin/yarn && bundle exec overcommit --install)

  If some changes are made to this hook, you will have to update it running this command from the repository's root directory: BUNDLE_GEMFILE=WcaOnRails/Gemfile bundle exec overcommit --sign.

Run using Docker (simplest option, but only runs the Rails portions of the site)

• Install Docker (remember to complete the Linux post-install steps if you're on Linux)
• Install docker-compose. The best way to get an up-to-date version is to get it from their releases page
• Navigate into the repository's main directory (worldcubeassociation.org)
• To start the server at http://localhost:3000, run docker-compose up and to bring it down, docker-compose down (or just press ctrl + c in the same terminal)
• To run tests, run docker-compose exec wca_on_rails bash -c "RAILS_ENV=test bin/rake db:reset && RAILS_ENV=test bin/rake assets:precompile && bin/rspec"
• If you're using Visual Studio Code to develop, you can attach it to the Docker container so that your extensions can take advantage of the Ruby environment and so the terminal runs from inside the container

Run directly with Ruby (lightweight, also only runs the Rails portions of the site)

• Install MySQL 8.0, and set it up with a user with username "root" with an empty password. If it poses problems, try the following:

  # Run MySQL CLI as administrator and set an empty password for the root user:
  sudo mysql -u root
  ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY '';

• Install dependencies and load development database.
  1. cd WcaOnRails/
  2. Install Node.js and yarn, we need them for our javascript assets. Feel free to take a look at our chef recipe for the accurate versions we use and how we install them. Please note that other versions may work, but it is not guaranteed.
  3. bundle install && bin/yarn
  4. bin/rake db:load:development - Download and import the developer's database export. Depending on your computer it may take a long time. Alternatively you can run bin/rake db:reset which will create the database and seed it with random data (it's way faster, but less representative of our website content).
  5. bin/rails server - Run rails. The server will be accessible at localhost:3000
• Run tests.
  1. RAILS_ENV=test bin/rake db:reset - Set up test database.
  2. RAILS_ENV=test bin/rake assets:precompile - Compile some assets needed for tests to run.
  3. bin/rspec - Run tests.
• Mailcatcher is a good tool for catching emails in development.

Run in Vagrant (gets everything working, but is very slow, recommended only if you need to run the PHP portions of the website)

• Install Vagrant, which requires VirtualBox.
• vagrant up all - Once the VM finishes initializing (which can take some time), the website will be accessible at http://localhost:2331.
  • Note: There are some minor issues with development on Windows.
• All emails will be accessible at http://localhost:2332.
• Please take a look at this wiki page for more detailed informations about the application's internals.

Production

See Spinning up a new server and Merging and deploying.