Files
stellar/README.md
jason 177be6332b
Some checks failed
CI / validate (push) Has been cancelled
M0
2026-03-22 23:33:24 -05:00

1.4 KiB

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

npm install
npm run dev

Client defaults to http://localhost:5173. API defaults to http://localhost:3000.

Docker

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

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 validates:

  • npm ci
  • npm run lint
  • npm run test
  • npm run build
  • docker compose -f docker/docker-compose.yml build