RVA

This is the code that powers the website and backend services for Re-Volt America (RVA), the American community around the popular RC Cars racing game Re-Volt from 1999.

In order to play online, we use RVGL, a cross-platform rewrite / port of Re-Volt that runs natively on a wide variety of platforms. This version of the game is also known for extending the original game experience with support for custom, community-made content such as tracks and cars.

On RVA, we organise a series of online sessions where players from all around the world (primarily from the American continent) get to race against each other, score points for the races they play, and get indexed into Re-Volt Americas' official rankings.

RVGL Results	RVGL Results

This project aims to be the main website for RVA, where online session logs will be uploaded and parsed into RVA's results format to be displayed. The site will also help manage and maintain a wide range of information related to RVA's internal scoring system.

Table of Contents

• Architecture
• Installation
  • Ubuntu 18.04
    • Download & Install
    • Mounting
    • Database Setup
      • MongoDB
      • Redis
    • Environment
• Docker
• Contributing
• Governance
• Licence
• Thanks To
  • Developers
  • Sponsors

Architecture

This repo contains the following components:

• Database models used by all parts of the network.
• The public website, including an admin interface used for some essential configuration.
• Several services which perform tasks like parsing and calculating results tables and leaderboards.

This project was built using Ruby on Rails, the full-stack framework.

Installation

Install the following services and configure them to run on their default ports if needed:

• Ruby 3.2.2
  • OS X: RVM is recommended over the default OS X Ruby. Here's a one-liner: \curl -sSL https://get.rvm.io | bash -s stable --ruby
• MongoDB 3+
• Redis 7+
• NodeJS 16+
• Yarn 1.22+

Ubuntu 18.04

The following installation instructions are specific to Linux, Ubuntu 18.04. This is the recommended OS to run the RVA website on.

In a clean Ubuntu install, run the following commands in super-user mode to get and run all the required services and tools:

Enable super-user mode.

sudo su

Download & Install

Update & Upgrade Packages.

apt-get update -y && apt-get upgrade -y

Update GNU Privacy Guard.

apt-get install gnupg2

Install Curl.

apt-get install curl

Install NodeJS.

curl -sL https://deb.nodesource.com/setup_16.x -o /tmp/nodesource_setup.sh
sudo bash /tmp/nodesource_setup.sh
sudo apt-get install -y nodejs

Install Yarn.

npm install -g yarn

Install MongoDB & Redis.

apt-get install mongodb -y && apt-get install redis-server -y

Start the mongodb & redis-server services.

service mongodb start && service redis-server start

Download and Install Ruby Version Manager (RVM). Run the following commands WITHOUT super user rights, and replace <username> with your unix username.

command curl -sSL https://rvm.io/pkuczynski.asc | gpg2 --import -
\curl -sSL https://get.rvm.io | bash -s stable
source /home/<username>/.rvm/scripts/rvm

Install Ruby 3.2.2 via RVM.

rvm install 3.2.2

With the following command you should be able to see your installed Ruby versions and use version 2.7.3

rvm list
rvm use 3.2.2

Mounting

Install Git.

sudo apt-get install git -y

Clone this repository to your machine and cd into it:

git clone https://github.com/Re-Volt-America/RVA
cd RVA

Ensure bundler is installed:

gem install bundler

Download and install dependencies:

bundler install

Run yarn install tasks:

yarn install
yarn build
yarn build:css

Database Setup

Both MongoDB and Redis come configured to work on "localhost" by default. If you run the application with Docker, make sure to change "localhost" for "mongo" and "redis" respectively. For example, in the monoid.yml file, you would have to change - "localhost:27017" to - "mongo:27017".

MongoDB

You may edit your MongoDB client configuration from the config/mongoid.yml file. Since Mongo is running on its default port, you don't need to do anything here. Default settings should suffice. You may modify this file in case you want to change the default connection strategy or other mongoid options.

In the project's root, there is a directory named db/. This directory contains several MongoDB exported collections with sample data. Using these files, you will be able to simulate a working environment to parse session results on the site.

Import each file as follows:

mongoimport --host localhost:27017 --db rv_cars --collection cars --file rv_cars.cars.json --jsonArray &&
mongoimport --host localhost:27017 --db rv_rankings --collection rankings --file rv_rankings.rankings.json --jsonArray &&
mongoimport --host localhost:27017 --db rv_seasons --collection seasons --file rv_seasons.seasons.json --jsonArray &&
mongoimport --host localhost:27017 --db rv_tracks --collection tracks --file rv_tracks.tracks.json --jsonArray &&
mongoimport --host localhost:27017 --db rv_users --collection users --file rv_users.users.json --jsonArray

In order for these imports to work from a Docker context, replace "--host localhost:27017" with "--host mongo:27017".

Redis

The caching configuration and connection to the Redis database you may find here:

• config/environments/development.rb
• config/environments/production.rb

Very much like it happens with Mongo, since Redis is running on its default port, you don't need to do anything here. Default settings should suffice. You may modify this file in case you want to change the default connection info or other Redis options.

Environment

Run the following shell command from the RVA repo to start the application:

rails rva -b HOST -p PORT              # Public website on http://`<host>`:`<port>`

Replace <host> and <port> with the desired host and port you would like to use for the website. For example, you could run the application on host 0.0.0.0 and port 80 to make the site accessible from outside localhost.

At this point, you should be able to visit the website at http://<host>:<port>. If you followed the Database Setup instructions for MongoDB, you should be able to login with the following test credentials of an admin user:

Credentials

• Email: admin@example.com
• Password: adminadmin

Docker

This project includes a docker-compose.yml file ready to use in order to run using Docker.

The Docker configuration is designed to work from the project folder itself, so in order to run it you must first clone this repository and cd into it:

git clone https://github.com/Re-Volt-America/RVA
cd RVA

Once inside, simply run docker compose and let it do its thing:

docker-compose up

When it finishes building and setting up, you should be able to access the site on localhost:3000.

Contributing

Please read the full instructions on how to contribute to this project found in the CONTRIBUTING.md file.

Governance

The lead maintainer of this project is BGM. As the project grows, we'll scale the governance model to meet those needs.

Licence

RVA Website/Backend is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public Licence as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public Licence for more details.

A copy of the GNU Affero General Public Licence is included in the file LICENCE, and can also be found at https://www.gnu.org/licenses/agpl-3.0.en.html.

The AGPL license is quite restrictive, please make sure you understand it. If you run a modified version of this software as a network service, anyone who can use that service must also have access to the modified source code.

Thanks to

Developers

• Marco Roth. For helping with the esbuild migration and solving some HAML issues.

Sponsors

• Gabriel Carnielli.
• Mateusz Kobylański.
• Benjamin Mosso.
• Juan Pablo Rosas.
• Leandro Rodriguez.
• Dario Chaile.