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.
In 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.
- Architecture
- Installation
- Database Setup
- Environment
- Docker
- Contributing
- Governance
- Licence
- Thanks To
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.
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
- OS X: RVM is recommended over the default OS X Ruby. Here's a one-liner:
- MongoDB 3+
- Redis 7+
- NodeJS 16+
- Yarn 1.22+
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 mongoid.yml file, you would have
to change - "localhost:27017" to - "mongo:27017".
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.
The caching configuration and connection to the Redis database you may find here:
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.
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>.
Please read the full instructions on how to contribute to this project found in the CONTRIBUTING.md file.
You may also have a look at the repository wiki.
The lead maintainer of this project is BGM. As the project grows, we'll scale the governance model to meet its needs.
- Marco Roth. For helping with the esbuild migration and solving some HAML issues.
- Nicolás Duque. For testing the installation instructions on Linux platforms, beta-testing the site on its early stages, and helping with i18n.