A re-write of the original Portal 2 Challenge Mode Leaderboards designed to take advantage of modern web technology and allow for the community to take a more active role in developing the leadboards.
Using sqlx to pass queries to our database. REST API to be documented. Requires the Database to be up and operational.
Be sure to copy the .env.example file, remove .example from the file name, and change the contents of the file to suite your usecase.
DATABASE_URL=postgresql://username:123@localhost/p2boards
SERVER.HOST=0.0.0.0
SERVER.PORT=8080
PROOF.RESULTS=500
PROOF.DEMO=200
PROOF.VIDEO=200
STEAM.API_KEY=
BACKBLAZE.KEYID=
BACKBLAZE.KEY=
BACKBLAZE.BUCKET=
RUST_LOG=1
RUST_LOG="actix_web=info"
Assuming the database is up and running, start the server with. cargo run in /server
- Endpoints interacting with the data on the boards. Documented here.
- Feature parity with current boards started by ncla, updated & maintained by iVerb & Jonese.
- Support for enhanced admin capabilities.
- Category support built in.
- Coupling of cooperative times.
The backend now works as a REST API that allows for updating of scores from the official steam leaderboards, as well as point calculations and avatar updating. It handles direct interactions with Valve's API.
The backend does not rely on a database, but does depend on the webserver running to be able to pull information about the current state of the boards.
You're required to have a steam API key, apply for one here.
Copy the .env.example file in the /backend folder, and rename it to .env, then fill out the steam_api_key value.
STEAM_API_KEY=8U0SG8SDG7S0DHISD0FHS0DV7SD
Assuming the web server is running locally, run with cargo run in /backend
- Update the web server with scores from the steam leaderboard.
- Update profile images for users from the steam API.
- Create new users when their score is added to the leaderboards.
- Calculate the points to display on the leaderboards.
- Install
postgresand setup a user (reference theDATABASE_URLbellow). - Open psql console,
CREATE DATABASE p2boards; - Load the latest dump from
/db/dbdumpwithpsql p2boards < most_recent_dump_file_name.sql
The front-end build can be done with npm install in the /board-portal-2 folder and once dependancies are installed, the client server can be started with npm start
- Supports querying a running webserver on it's given endpoints for changelog, preview pages, sp maps and coop maps.
- Light and dark theme support.
- Prototyped page designs for many auxiliary pages.
@cesarila has contributed a working Docker solution to building the boards. For those unfamiliar with Docker, it allows you to run different container environments that act similar to to lightweigth Virtual Machines, where you can define ahead of time what is installed on the containers when they're built. This means minimal technical knowledge needed outside of learning to use Docker (details below). The main drawback of this is that you have less direct control over your environment, and the performance is much worse.
If you're familiar with development on Linux/WSL, I would recommend installing Postgres, Rust and Node locally, but if you're looking to mess around and learn as a beginner, or only want to work on the Front-end, I would recommend using Docker. Additionally, if you want to focus on entirely front-end contributions, contact Daniel for information on a publicaly accessible IP you can use to hit the backend API endpoints without needing to build it on your machine.
- Docker
- https://docs.docker.com/get-docker/
- Optional Post-Installation Steps:
- Have docker-compose available (Linux only, comes bundled with Docker desktop for Mac and Windows):
- https://docs.docker.com/compose/cli-command/#install-on-linux
- Short Version:
mkdir -p ~/.docker/cli-plugins/ sudo curl -L "https://github.com/docker/compose/releases/download/v2.1.0/docker-compose-$(uname -s)-$(uname -m)" -o ~/.docker/cli-plugins/docker-compose sudo chmod +x ~/.docker/cli-plugins
- Note: v2.1.0 is the latest release at the time of writing this. All releases visible at: https://github.com/docker/compose/releases/
- Shortest Version: https://gist.github.com/cesarila/a58504fbc3924bcef6ae8ce83a652071
Assuming you've satisfied the prerequisites, you can build the containers from the root directory of this repo with:
docker compose build
This only needs to be done on changes to entrypoint scripts, dockerfiles, and docker-compose.yaml. This includes changes made by people other than you.
If you don't want to think about it, always rebuild your containers after pulling from the repo.
Run containers in the foreground:
docker compose up
Run containers in the background with logging visible:
docker compose up &
Run containers detatched from the current shell (no logging visible):
docker compose up -d
Copy the .env.example file in the /server folder, and rename it to .env, change the contents to follow the convention below.
The DATABASE_URL field should be identical if the docker files are unchanged, and the SERVER.HOST should bind to 0.0.0.0 rather than 127.0.0.1 for running in a Docker container.
DATABASE_URL=postgresql://docker:docker@postgres/p2boards
SERVER.HOST=0.0.0.0
SERVER.PORT=8080
PROOF.RESULTS=500
PROOF.DEMO=200
PROOF.VIDEO=200
STEAM.API_KEY=
BACKBLAZE.KEYID=
BACKBLAZE.KEY=
BACKBLAZE.BUCKET=
RUST_LOG=1
RUST_LOG="actix_web=info"
To rebuild the database volume from the database dump, do the following:
docker compose down #make sure all containers are stopped
docker volume rm portal2-cm-boards-v2_postgres_data
docker compose build
docker compose upIf this doesn't work for any reason, one thing to check is that the file copied in db/Dockerfile is the same as the dump in db/dbdump. If these files don't match, make them match, save your changes, and try the above steps again.
This project started as a Senior Capstone Project for the following members.