Package documentation

The docs live with the package so future work can continue without guesswork.

These markdown files describe ownership, setup, backend boundaries, environment variables, and implementation progress. They are intended to stay in lock-step with the code scaffold in this workspace.

Developer guides

Cornerstone SDK

Use the SDK transport and domain clients outside UI code while keeping credentials and environment policy in the consuming application.

Read the SDK guide

Activity Plugin SDK

Create, validate, test, and package static Activity plugins against the versioned manifest and MessageChannel bridge.

Read the plugin guide

Architecture

Package boundaries, auth flow, payment flow, webhook flow, and entitlement flow.

docs/platform/architecture.md

Source Map

Explains what files belong to the site package, backend functions, shared config, and repo root.

docs/platform/source-map.md

Firebase Setup

Project setup, auth providers, Firestore expectations, emulator flow, and deploy notes.

docs/platform/firebase-setup.md

Stripe Setup

Stripe products, checkout orchestration, webhook handling, metadata strategy, and local testing.

docs/platform/stripe-setup.md

Environment

Frontend and backend environment variable expectations for local and deployed environments.

docs/platform/environment.md

Progress

Current build stage, completed work, open items, blockers, and next delivery steps.

docs/platform/progress.md

Journey Map

Suggested execution order from public scaffold to Firebase, Stripe, entitlements, and deployment.

docs/platform/journey-map.md

Frontend environment checklist

PLATFORM_SITE_URL

Validated public Site origin for the current deployment environment.

PLATFORM_STUDIO_URL

Validated Studio origin used by Firebase email verification return links.

PLATFORM_ADMIN_URL

Validated Admin origin used for cross-application navigation from Studio.

PLATFORM_FIREBASE_API_KEY

Firebase web app API key for the platform site client.

PLATFORM_FIREBASE_AUTH_DOMAIN

Firebase auth domain used for browser sign-in flows.

PLATFORM_FIREBASE_PROJECT_ID

Firebase project id shared by auth, Firestore, and Functions.

PLATFORM_FIREBASE_STORAGE_BUCKET

Optional Firebase storage bucket for workspace and application assets.

PLATFORM_FIREBASE_MESSAGING_SENDER_ID

Firebase sender id for the web app config bundle.

PLATFORM_FIREBASE_APP_ID

Firebase web app id for the platform site client.

PLATFORM_FIREBASE_DATABASE_URL

Firebase Realtime Database URL used by live Session presence and controls.

PLATFORM_FIREBASE_APP_CHECK_SITE_KEY

Optional reCAPTCHA v3 site key used by Firebase App Check for public Session entry.

PLATFORM_FIREBASE_MEASUREMENT_ID

Optional measurement id used by Firebase Analytics in web clients.

PLATFORM_FIREBASE_FUNCTIONS_REGION

Functions region used when calling checkout orchestration.

PLATFORM_FIREBASE_USE_EMULATORS

Local-only flag that connects every Firebase browser client to the Emulator Suite.

PLATFORM_FIREBASE_EMULATOR_HOST

Loopback Firebase emulator host; fixed to 127.0.0.1 by the local profile.

PLATFORM_CHECKOUT_FUNCTION_NAME

Callable function name used to create Stripe Checkout sessions.

PLATFORM_CREATE_CHECKOUT_SESSION_URL

HTTPS endpoint used by the email-first checkout flow.

PLATFORM_CHECK_ACCESS_URL

Authenticated HTTPS endpoint used to verify the signed-in user’s boolean access state.

PLATFORM_CREATE_FREE_ACCOUNT_URL

HTTPS endpoint used to create or update free user profiles.

PLATFORM_CREATE_DASHBOARD_USER_URL

HTTPS endpoint used by super admins to create dashboard users.

PLATFORM_UPDATE_DASHBOARD_USER_URL

HTTPS endpoint used by super admins to update dashboard users.

PLATFORM_DELETE_DASHBOARD_USER_URL

HTTPS endpoint used by super admins to delete dashboard users.

PLATFORM_RESET_DASHBOARD_USER_PASSWORD_URL

HTTPS endpoint used by super admins to send reset emails or set user passwords.

PLATFORM_FORCE_DASHBOARD_USER_SIGN_IN_URL

HTTPS endpoint used by super admins to force a dashboard user to sign in again.

PLATFORM_WORKSPACES_URL

HTTPS endpoint used to create workspaces and manage memberships.

PLATFORM_EXPERIENCE_STUDIO_URL

HTTPS endpoint used to author and publish workspace Courses.

PLATFORM_SESSIONS_URL

HTTPS endpoint used to create, join, and control workspace Sessions.

PLATFORM_BILLING_URL

HTTPS endpoint used for subscription lifecycle management.

PLATFORM_TOOL_REQUESTS_URL

HTTPS endpoint used for gated tool requests and capability decisions.

PLATFORM_UPDATE_USER_SELECTED_PRODUCTS_URL

HTTPS endpoint used to validate and save dashboard product selection.

PLATFORM_UPDATE_USER_FEATURE_DATA_URL

HTTPS endpoint used to persist per-user feature data snapshots.

PLATFORM_ADMIN_MUTATIONS_URL

Authenticated HTTPS endpoint for bounded Admin configuration, Stripe-code, and product-catalog mutations.

PLATFORM_SUPPORT_INSPECTION_URL

HTTPS endpoint for bounded Admin-issued Studio support-inspection sessions.

PLATFORM_STRIPE_PUBLISHABLE_KEY

Optional Stripe publishable key for future client-side billing UI additions.