Myx
66c6f34cd3
All checks were successful
Queue Release Build / prepare (push) Successful in 21s
Deploy Web Apps / deploy (push) Successful in 5m14s
Queue Release Build / build-windows (push) Successful in 16m18s
Queue Release Build / build-linux (push) Successful in 29m20s
Queue Release Build / finalize (push) Successful in 36s
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# Server
|
|
|
|
Node/TypeScript signaling server for MetoYou / Toju. This package owns the public server-directory API, join-request flows, websocket runtime, and server-side persistence.
|
|
|
|
## Install
|
|
|
|
1. Run `cd server`.
|
|
2. Run `npm install`.
|
|
|
|
## Commands
|
|
|
|
- `npm run dev` starts the server with `ts-node-dev` reload.
|
|
- `npm run build` compiles TypeScript to `dist/`.
|
|
- `npm run start` runs the compiled server.
|
|
- From the repository root, `npm run server:dev`, `npm run server:build`, and `npm run server:start` call the same package commands.
|
|
|
|
## Runtime Config
|
|
|
|
- The server loads the repository-root `.env` file on startup.
|
|
- `SSL` can override the effective HTTP protocol, and `PORT` can override the effective port.
|
|
- `DB_PATH` can override the SQLite database file location.
|
|
- `data/variables.json` is normalized on startup and stores `klipyApiKey`, `rawgApiKey`, `releaseManifestUrl`, `serverPort`, `serverProtocol`, `serverHost`, and `linkPreview`.
|
|
- `RAWG_API_KEY` can override `rawgApiKey` for the `/api/games/match` now-playing metadata resolver. Successful matches include a preferred store link from RAWG store metadata, with Steam selected first when available. Negative game-match results are stored in the SQLite `game_match_misses` table so non-game process names do not repeatedly consume RAWG quota.
|
|
- Packaged server builds store `metoyou.sqlite` in the OS app-data directory by default so upgrades do not overwrite runtime data. On first start, the server copies forward legacy packaged databases that still live beside the executable.
|
|
- When HTTPS is enabled, certificates are read from the repository `.certs/` directory.
|
|
|
|
## Structure
|
|
|
|
| Path | Description |
|
|
| --- | --- |
|
|
| `src/index.ts` | Bootstrap and server startup |
|
|
| `src/app/` | Express app composition |
|
|
| `src/routes/` | REST API routes |
|
|
| `src/websocket/` | WebSocket runtime and signaling transport |
|
|
| `src/cqrs/` | Command/query handlers |
|
|
| `src/config/` | Runtime config loading and normalization |
|
|
| `src/db/`, `src/entities/`, `src/migrations/` | Persistence layer |
|
|
| `data/` | Runtime data files such as `variables.json` |
|
|
|
|
## Notes
|
|
|
|
- `dist/` and `../dist-server/` are generated output.
|
|
- See [AGENTS.md](AGENTS.md) for package-specific editing guidance.
|