Getting Started

shared-packages is the source of truth for the @caffeinebounce/* package family. Use this repo when you are adding or changing shared UI, auth, email, utility, logging, commerce, or notification behavior.

Prerequisites

• Node.js 25.x
• Yarn 4.12.0
• A GitHub token that can read GitHub Packages

Add the scoped registry before installing:

@caffeinebounce:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Local workflow

yarn install
yarn build
yarn typecheck
yarn test
yarn validate:packages
yarn docs:build

Where to start

• Use the package catalog to choose the right shared package before building new functionality.
• Prefer updating existing entrypoints over creating ad hoc exports in app repos.
• Add a Changeset for any published package behavior change.
• Regenerate the docs manifest whenever you change package exports, versions, or authored docs content.

What this portal covers

• Repo setup and publishing expectations
• Package overviews for all 8 published packages
• Full reference coverage for ui, identity, and shared-utils
• Source-linked entrypoints, examples, and changelog breadcrumbs

Related

• The release flow is documented in the Release Policy page.
• The docs authoring workflow is documented in Contributing and Updating Docs.