Athas Boilerplate

Athas Boilerplate

Overview Canonical Scope Architecture Backend Patterns Frontend Patterns API Interfaces Modular Composition Audience Projections Development Flow Getting Started Feature Scaffolding Backend Module Workflow Database Migrations Module Composition Guide Docs Information Architecture Starter CLI Workflows Runtime Feature Flags (OpenFeature)UI Library Hardening Performance Guidelines Runtime Telemetry @athas/shared-api @athas/contracts @athas/db @athas/auth-core capabilities @athas/shared-utils @athas/notifications-core @athas/integrations-core AI-Assisted Docs Workflow Module Profiles Hard-Remove Workflow Commerce Sprint Plan Foundation Closeout

API Interfaces

shared

Contract-first API model using oRPC for first-party and HTTP/OpenAPI for external consumers.

Interface strategy

oRPC is primary for first-party apps.
HTTP/OpenAPI remains available for external integrations and webhooks.
both adapters call the same application/use-case layer.

Audience model

public
client
admin

Each namespace must map to explicit projection schemas.

Contract-first flow

Define schemas/contracts in @athas/contracts.
Implement backend handlers against shared contracts.
Consume typed clients from frontend feature APIs.
keep projection policy checks enabled in CI.

OpenAPI surfaces

/api/openapi.json (HTTP)
/api/orpc/openapi.json (oRPC)

Related deep reference

Detailed policy: docs/architecture/32-api-architecture.md.

Frontend Patterns

Feature-slice frontend conventions for routes, APIs, and shared UI use.

Modular Composition

How modules are soft-disabled, hard-removed, and packaged for starter profiles.

On this page

Interface strategy Audience model Contract-first flow OpenAPI surfaces Related deep reference