Developer
39 chapters across 14 sections
Getting started
Authentication
Authentication — Concepts & Flow
Overview of the Wakastart OAuth2 PKCE flow: key concepts, complete diagram and Keycloak prerequisites.
Authentication — PKCE Implementation
Complete PKCE flow code: generation, start-login, exchange, enrichment, cookies and logout.
User context — /me payload structure
Complete structure of the /me payload: identity, access levels, teams, application rights and features.
User context — Cache & Invalidation
When to call /me, React caching strategy, invalidation after token refresh and best practices.
Security
Access control — Model & Cascade
Wakastart's 2 rights vectors: adminLevel and appRights (resource.action rights), and enabled-feature checks.
Access control — Guards & Hooks
Full implementation: useAppRights hook, Protected component, NestJS AppRightGuard.
Access control — Feature Flags
App/Network/Customer feature cascade, conditional activation and integration in guards.
Best Practices — Security
Tokens, secrets, HTTPS, CSP, logs: the non-negotiable security rules for a Wakapp in production.
Best Practices — Performance & Observability
Cache, proactive refresh, pagination, TanStack Query, Prometheus metrics, and structured logging.
Common integration pitfalls
The 10 most frequent mistakes when integrating a Wakapp: symptom, cause and solution.
Using the API
Using the API — REST Conventions
Authenticating requests, pagination, filters, automatic multi-tenancy, and unified error format.
API Usage — Headers & Rate Limits
Required and optional headers, idempotency, CORS, rate limiting and exponential backoff.
Endpoint reference
Exhaustive table of all Discovery, Auth, profile, CRUD, invitations and modules endpoints available for a WakaApp.
Errors — HTTP Codes
Unified error format, HTTP codes 400 to 5xx, causes and handling strategies for a robust Wakapp.
Errors — Business Codes
Wakastart business error codes, exact messages that can be tested programmatically, and status mappings.
Modules
Invitations API — Creation
Create an invitation: prerequisites, POST /api/invitations endpoint, body, response and error handling.
Invitations API — Verification & Acceptance
The verify and accept endpoints: implementing the acceptance page, server-side effects and pitfalls.
MCP Server — Overview
The WakaStart MCP server hosted on docs.wakastart.app: 5 tools, available resources and technical characteristics.
MCP Server — Claude Code Configuration
Configure Claude Code with .mcp.json to access the WakaStart MCP server at docs.wakastart.app.
Architecture model
Architecture as JSON
Sources & services
Repository (Git repository)
Managed or imported repos: the source of the code you'll build.
Service — executable component
ServiceDefinition (architecture) vs ServiceInstance (environment): the 2-level pattern.
Build — from code to Docker image
The pipeline that turns your Git code into a deployable Docker image.
Databases, storage, routing
Databases and storage
PostgreSQL, MongoDB, Valkey, and S3 buckets: your app's persistent dependencies.
URLs and routing
Domains, subdomains, and HttpRoutes: how Wakastart routes HTTP traffic to your services.
Variables and Secrets
How Wakastart delivers config to your services: architecture, environment configuration, binding.
URL Redirects
Redirect a Network or Customer subdomain to an existing application route, via a shared HAProxy component.
Environments & lifecycle
Environments
An environment = a complete, isolated instance of your app. Main fields, lifecycle, dashboard.
Resource Lifecycle
Statuses PENDING → PROVISIONING → PROVISIONED → DESTROYING → DESTROYED.
Builds vs Deployments
Crucial difference: a Build produces an image, a Deployment launches pods. AUTO vs MANUAL mode.