Contributing¶

Prerequisites¶

Node.js 20+ (the server requires Node.js 22 — see Software)
Git configured with your GitHub account

Setup¶

git clone https://github.com/kevinwcrump/toasterchef.git
cd toasterchef

Install dependencies for each package:

cd server && npm install
cd ../client && npm install
cd ../shared && npm install

Running locally¶

# Start the Colyseus game server
cd server && npm run dev

# Start the Phaser 3 client (in a separate terminal)
cd client && npm run dev

Check server/package.json and client/package.json for exact script names. Remember the build order: the shared package must be built before the server or client can import its types.

Branch strategy¶

main      — stable
dev       — integration
feature/* — per-task (PR to dev)

Never push directly to main.