Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.saas-boilerplate

SaaS Boilerplate - Users, Orgs, Projects, Billing, Settings

examplesexamplev5.0.4stableservernode
@lssm-tech/example.saas-boilerplate
bun add @lssm-tech/example.saas-boilerplate
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

SaaS Boilerplate - Users, Orgs, Projects, Billing, Settings.

What This Demonstrates

  • Multi-domain SaaS architecture (billing, project, settings, dashboard).
  • Per-domain entity/enum/event/handler/operations/presentation/schema pattern.
  • React UI with hooks, modals, overlays, renderers, and dashboard.
  • Contract-backed visualizations for portfolio status, tier mix, usage, and recent project activity.
  • Feature definition, seeders, and test-spec patterns.
  • RBAC, audit trail, and notification module integration.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/saas-boilerplate:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck

Usage

Use @lssm-tech/example.saas-boilerplate as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/billing is part of the package's public or composition surface.
  • src/dashboard is part of the package's public or composition surface.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/example.ts is the runnable example entrypoint.
  • src/handlers/ contains handlers or demo adapters wired to contract surfaces.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/presentations is part of the package's public or composition surface.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./billing resolves through ./src/billing/index.ts.
  • Export ./billing/billing.entity resolves through ./src/billing/billing.entity.ts.
  • Export ./billing/billing.enum resolves through ./src/billing/billing.enum.ts.
  • Export ./billing/billing.event resolves through ./src/billing/billing.event.ts.
  • Export ./billing/billing.handler resolves through ./src/billing/billing.handler.ts.
  • Export ./billing/billing.operations resolves through ./src/billing/billing.operations.ts.
  • Export ./billing/billing.presentation resolves through ./src/billing/billing.presentation.ts.
  • Export ./billing/billing.schema resolves through ./src/billing/billing.schema.ts.
  • Export ./dashboard resolves through ./src/dashboard/index.ts.
  • The package publishes 48 total export subpaths; keep docs aligned with package.json.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test --pass-with-no-tests
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.
  • Missing contract layers.

Notes

  • Works alongside @lssm-tech/lib.contracts-spec, @lssm-tech/lib.design-system, @lssm-tech/lib.example-shared-ui, @lssm-tech/lib.identity-rbac, @lssm-tech/lib.jobs, ...

Relationships

THIS PACKAGEexample.saas-boilerplate52 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

12 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .
  • lint:checknode ../../scripts/biome.cjs check .
  • testbun test --pass-with-no-tests
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit