Joshua Higgins
f9607b4628
- Add overview and prerequisites - Provide local dev and Docker run steps - Document useful npm scripts
1.7 KiB
1.7 KiB
Connect4 Moderator Observer UI
A website interface for connecting to the Connect4 WebSocket server as an observer or player, watching live matches, and managing tournaments.
Prerequisites
- Linux/macOS terminal or Windows PowerShell
- Git
- Docker (optional, for containerized runs)
Run Locally (Node.js + npm)
1) Install Node.js (includes npm)
Option A: Install with nvm (recommended, including Windows support)
On Linux/macOS:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
source ~/.zshrc
nvm install --lts
nvm use --lts
node -v
npm -v
On Windows (PowerShell), use nvm-windows:
winget install CoreyButler.NVMforWindows
nvm install lts
nvm use lts
node -v
npm -v
2) Install dependencies
From the project root:
npm i
3) Start the UI in development mode
npm run dev
Open http://localhost:3000.
Run with Docker
This repository includes:
Dockerfile(multi-stage production build)docker-compose.ymldocker_build.sh
Build image directly from Dockerfile
docker build . -t joshuafhiggins/connect4-ui
or use the provided script:
./docker_build.sh
Run container directly
docker run --rm -p 3000:3000 --name connect4-ui joshuafhiggins/connect4-ui
Run with Docker Compose
docker compose up --build
Run detached:
docker compose up -d --build
Stop:
docker compose down
Useful npm Scripts
npm run dev- start Next.js dev servernpm run build- build for productionnpm run start- run production buildnpm run lint- lint the project