M0

README.md

@@ -0,0 +1,61 @@
+# Stellar
+
+Space-themed absorber game built as a React + Matter.js client with a small Express + SQLite API.
+
+## Status
+
+The repository is currently scaffolded through M0:
+
+- React 18 + TypeScript + Vite client
+- Express + TypeScript API with `pino` logging
+- Single-container Docker build that serves the client and API from one process
+- Workspace-based root scripts for local development and builds
+- CI workflow for install, lint, test, build, and Docker verification
+- Baseline docs and test folders
+
+## Quick Start
+
+```bash
+npm install
+npm run dev
+```
+
+Client defaults to `http://localhost:5173`.
+API defaults to `http://localhost:3000`.
+
+## Docker
+
+```bash
+npm run docker-up
+```
+
+This starts the single production-style container on `http://localhost:8080`.
+Static assets and API routes are served by the same Express process.
+
+## Scripts
+
+```bash
+npm run dev
+npm run build
+npm run test
+npm run lint
+npm run docker-build
+```
+
+## Project Structure
+
+- `client/` React frontend and game runtime
+- `server/` Express API, static asset host, and future persistence layer
+- `docker/` container definitions
+- `docs/` architecture and contributor docs
+- `tests/` reserved for shared test assets and future end-to-end coverage
+
+## CI
+
+[`ci.yml`](F:\CODING\stellar\.github\workflows\ci.yml) validates:
+
+- `npm ci`
+- `npm run lint`
+- `npm run test`
+- `npm run build`
+- `docker compose -f docker/docker-compose.yml build`