StatsHub Docs

StatsHub documentation

Architecture, setup, and conventions for the StatsHub monorepo.

Choose the app or task you are working on.

Local services

ServiceCommandAddress
Webpnpm devhttp://localhost:3000
Docspnpm dev:docshttp://localhost:3001/docs
APIpnpm dev:apihttp://localhost:8080/api/health
Expopnpm dev:expoMetro on port 8142

This development box is remote. From another device, use the addresses from node packages/statshub-tooling/apps.cjs, not localhost.

Repository map

  • apps/ contains the web, API, Expo, and docs applications.
  • packages/ contains shared UI, transport, configuration, filters, i18n, and tooling.
  • apps/web/src/pages/api is the behavior reference for the Go port.
  • apps/docs/content/docs is the only documentation source. Obsidian opens the same directory through a symlink.

Start with Getting started, then read Architecture and the relevant app section.

On this page