Preparation

• Add to GitHub teams

  • https://github.com/orgs/Spordle/teams/play/members

  • https://github.com/orgs/Spordle/teams/react-packages/members

• Create accounts in the staging environment and database

Environment Setup

Spordle Play uses a devcontainer which runs in VS Code and Docker. This helps keep development environments in sync and avoids clashing with anything else you’re working on.

The devcontainer is configured with docker-compose to automatically sets up an environment with containers for nodejs, Postgres, RabbitMQ, and Minio with the correct versions.

If you have these already installed, the container networking is configured to not conflict with existing ports and VS Code will automatically expose services to the next available port, while the standard ports are used within the devcontainer environment.

Windows

• Install WSL2 Ubuntu from the Microsoft Store
  https://apps.microsoft.com/store/detail/ubuntu-on-windows/9NBLGGH4MSV6

• Setup docker in WSL (Docker Desktop is not necessary if using above)

  • Enable systemd by updating /etc/wsl.conf to add:

    [boot]
    systemd=true

  • Install docker

    sudo apt update
    sudo apt install docker.io -y
    sudo usermod -aG docker $USER

  • Restart WSL

• Clone repository

  cd ~
  git clone git@github.com:Spordle/Play.git play

• Open in VS Code

  code ~/play

• Relaunch in devcontainer

• Check README.md for further instructions on how to install and build Spordle Play

macOS

TODO

Likely similar instructions above, but with Docker Desktop.