example.saas-boilerplate
SaaS Boilerplate - Users, Orgs, Projects, Billing, Settings
@lssm-tech/example.saas-boilerplatebun add @lssm-tech/example.saas-boilerplateManifest 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 devbun run buildbun run testbun 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/billingis part of the package's public or composition surface.src/dashboardis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/handlers/contains handlers or demo adapters wired to contract surfaces.src/index.tsis the root public barrel and package entrypoint.src/presentationsis part of the package's public or composition surface.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./billingresolves through./src/billing/index.ts. - Export
./billing/billing.entityresolves through./src/billing/billing.entity.ts. - Export
./billing/billing.enumresolves through./src/billing/billing.enum.ts. - Export
./billing/billing.eventresolves through./src/billing/billing.event.ts. - Export
./billing/billing.handlerresolves through./src/billing/billing.handler.ts. - Export
./billing/billing.operationsresolves through./src/billing/billing.operations.ts. - Export
./billing/billing.presentationresolves through./src/billing/billing.presentation.ts. - Export
./billing/billing.schemaresolves through./src/billing/billing.schema.ts. - Export
./dashboardresolves 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 devbun run build— contractspec-bun-build buildbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun 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
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
12 declarations
@lssm-tech/lib.identity-rbacworkspace:^
Read the package manual ↗@lssm-tech/lib.jobsworkspace:^
Read the package manual ↗@lssm-tech/lib.notificationworkspace:^
Read the package manual ↗@lssm-tech/module.audit-trailworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗
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 --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint: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-testsprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit