Files
stellar/README.md

63 lines
1.4 KiB
Markdown
Raw Normal View History

2026-03-22 23:33:24 -05:00
# 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.
2026-03-23 00:06:01 -05:00
You can also run `docker build .` directly from the repo root.
2026-03-22 23:33:24 -05:00
## 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
2026-03-23 00:06:01 -05:00
- `Dockerfile` and `compose.yml` define the container runtime
2026-03-22 23:33:24 -05:00
- `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`
2026-03-23 00:06:01 -05:00
- `docker compose build`