Skip to content

README.md

Latest commit

 

History

History
73 lines (60 loc) · 1.8 KB

README.md

File metadata and controls

73 lines (60 loc) · 1.8 KB
Raw

ReviewGuessr Setup Guide

This guide covers installation and setup for both the Client and Server projects, including Docker and monitoring tools.

Prerequisites

  • Docker & Docker Compose
  • Bun (for local development)
  • Node.js (optional, for some tooling)

1. Clone the Repository

git clone https://github.com/Timur310/SteamyQuizz.git
cd SteamyQuizz

2. Environment Variables

  • Copy .env.example to .env in the root and Server folders.
  • Edit values as needed (ports, passwords, etc).

3. Create Docker Network (if missing)

if ! docker network ls | grep -q 'proxy'; then
  docker network create proxy
fi

4. Build and Start All Services

docker compose up --build -d

5. Access Services

6. Local Development

Client

cd Client
bun install
bun run dev

Server

cd Server
bun install
bun run server

7. Update Steam App List

To update the Steam app list in the server:

cd Server
bun run update-steam

8. Troubleshooting

  • Ensure the proxy network exists before running Docker Compose.

9. Vite Environment Variables

Vite uses different .env files based on environment:

  • .env: loaded in all environments
  • .env.local: loaded in all environments, ignored by git
  • .env.development: loaded in development only
  • .env.production: loaded in production only
  • All variables must start with VITE_ to be exposed to client code (e.g., VITE_SOCKET_URL)

If you change environment variables, rebuild your client app to apply changes.

  • Check .env files for correct port and password values.
  • For Docker build errors, verify all referenced files/folders exist.

For more details, see individual project README files or ask for help!