Files
oaktracker/README.md
T

2.7 KiB

Professor Oak Challenge Trackers

Unified web portal hosting two standalone Professor Oak Challenge trackers under a shared landing hub:

  • / — Landing hub (index.html) showing live browser save summaries and launcher cards
  • /oras/ — Pokémon Omega Ruby & Alpha Sapphire tracker (oras/)
  • /luminescent-platinum/ — Pokémon Luminescent Platinum (v2.1) tracker (luminescent-platinum/)

All progress, save profiles, and toggles persist locally in your browser per game (poc-tracker:v1:* for ORAS, lumi-poc-tracker:v1:* for Luminescent Platinum), and each tracker has a ← Hub link in the top header plus Export Save / Import JSON backups.


Local Development & Tests

Requires Node.js 20+ (no external npm packages or build step required):

# Run unified site + ORAS + Luminescent Platinum test suites
npm test

# Serve unified site at http://127.0.0.1:4173
npm start

Uploading to Gitea (git.trevorstocks.ca)

This folder is already initialized with Git and ready to push once you create an empty repository on Gitea:

git remote add origin https://git.trevorstocks.ca/<your-username>/<repo-name>.git
git push -u origin main

Hosting in a Standalone Docker Container on Unraid

The repository includes a lightweight nginx:1.27-alpine Dockerfile, docker/nginx.conf, and docker-compose.yml configured cleanly for reverse proxies (absolute_redirect off, .mjs/.webp MIME types, trailing-slash redirects, /health probe, running on uncommon high port 28473).

Option A — Build Directly on Unraid (docker compose)

SSH into your Unraid server (e.g., into /mnt/user/appdata/professor-oak-tracker):

git clone https://git.trevorstocks.ca/<your-username>/<repo-name>.git /mnt/user/appdata/professor-oak-tracker
cd /mnt/user/appdata/professor-oak-tracker
docker compose up -d --build

To update later after pushing changes to Gitea:

cd /mnt/user/appdata/professor-oak-tracker
git pull
docker compose up -d --build

Option B — Reverse Proxy / Subdomain Setup (Nginx Proxy Manager / SWAG)

  • Default Compose port: 28473 on Unraid → container port 28473 (avoids 80, 443, 8080, 8088)
  • Nginx Proxy Manager / SWAG target:
    • Scheme: http (Nginx Proxy Manager handles HTTPS/SSL termination for your subdomain)
    • Forward Hostname / IP: your Unraid IP (or professor-oak-tracker if both containers share a custom Docker bridge network like proxynet)
    • Forward Port: 28473
    • Enable Websockets: not required, standard HTTPS/SSL termination works out of the box (for example, https://oak.trevorstocks.ca/)