F1ReplayTiming

(β˜… 849)

Visualisation of real-time track data and telemetry synced to F1 replays.

  • .dockerignore
  • .env.example
  • .gitignore
  • CHANGELOG.md
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/adn8naiagent/F1ReplayTiming

Downloads the entire project code from GitHub to your computer.

cd F1ReplayTiming

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker run -d -p 8000:8000 --env-file .env -v f1data:/data -v f1cache:/data/fastf1-cache ghcr.io/adn8naiagent/f1replaytiming:latest

Runs the built image as an actual container.

docker run -d -e PORT=9000 -p 9000:9000 --env-file .env -v f1data:/data -v f1cache:/data/fastf1-cache ghcr.io/adn8naiagent/f1replaytiming:latest

Runs the built image as an actual container.

docker compose exec f1timing python precompute.py 2026 --round 1

Runs the command against the services defined in the compose file.

docker compose exec f1timing python precompute.py 2026 --round 1 --session R

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m venv venv

Runs the Python script (or module).

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation