Skip to main content

Module reference

These pages are the module READMEs from the monorepo — one per workspace under apps/, services/, and packages/. They are the runnable entry point for each slice: scope, quick start, build/test commands, dependencies, and status.

This is not the narrative documentation in Documentation home. Use that tree for architecture, RFCs, roadmaps, and design notes. Use Reference when you need to know what a specific workspace contains and how to run it.

Quality bar and audit checklist: DOCS-README-STANDARDS.


Apps

Operational shells — the surfaces end users interact with.

WorkspaceRole
apps/webNext.js + Tamagui web app — desktop-first brewery vertical UI
apps/nativeReact Native + Expo native app — brew-day surface on iOS/Android
apps/web/e2ePlaywright E2E sub-suite for the web app

Web and native share UI through @umbraculum/ui and domain packages; see Cross-platform boundaries for auth, navigation, and what ships where.


Services

Backend processes and HTTP APIs.

WorkspaceRole
services/apiFastify API — auth, modules, AI consultant backend
services/api/src/seedSeed data helpers bundled with the API

Packages

Shared libraries consumed by apps and services. Package index with tier notes: modules/packages/README.

Browse the Packages category in the sidebar for the full list (@umbraculum/ui, @umbraculum/contracts, @umbraculum/i18n, canonical module contract packages, and others).

*-contracts package pages show an auto-injected Contract version banner (read from each package's src/version.ts). Pin the npm package at the same semver; frozen per-release docs snapshots (Docusaurus versioning, RFC-0005 P6) start with the first post-alpha contracts publish batch.


Edit on GitHub

Each reference page links to its source README.md in the umbraculum-dev repository. Changes land in the workspace README first; this site re-renders them on the next docs build.