Skip to content
Playdex

Local quickstart

This gets every service running on your machine. Steam, PSN and Xbox are simulated by WireMock, so you don’t need any real accounts or API keys.

You need: Docker (Docker Desktop or OrbStack) and Git.

  1. Clone the repository

    Terminal window
    git clone https://github.com/ivankaizer/playdex.git
    cd playdex
    cp .env.example .env

    .env holds optional Sentry and Telegram settings. Leave the values as they are for now.

  2. Point the Web app at your API

    The compose file assumes OrbStack domains (*.playdex.orb.local). Pick your setup:

    Nothing to change. OrbStack routes app.playdex.orb.local, ui.playdex.orb.local and admin.playdex.orb.local for you.

  3. Start everything

    Terminal window
    docker compose up --build

    The first build takes a few minutes. The API creates the database schema on startup. Wait until you see it listening on port 3000.

  4. Load demo data

    A fresh database has no accounts, not even an admin, so run the seeder once from the command line:

    Terminal window
    DATABASE_URL=postgresql://playdex:playdex@localhost:5432/playdex \
      dotnet run --project tools/Seeder

    Seeding generates two years of sessions, so give it a minute. After the first run, use Admin → Playground → Reset & seed demo data whenever you want a clean slate.

  5. Sign in

    App OrbStack Docker Desktop Account
    Web http://ui.playdex.orb.local http://localhost:5173 user@playdex.dev / password
    Admin http://admin.playdex.orb.local http://localhost:3100 admin@playdex.dev / password
    API docs http://app.playdex.orb.local/swagger http://localhost:3000/swagger —

  6. Make something happen

    In Admin, open Playground and click Steam → Playing Rogue Trader. Within about 10 seconds the poller opens a live session for user@playdex.dev, and it appears on the Admin dashboard and in the Web app. See the Playground guide for more.