Template reference

This page documents the OpenProductKit template surface: Copier configuration, generated packages and extension points.

Copier configuration

The template entry point is copier.yml at the repository root.

Setting	Value
_subdirectory	template
_templates_suffix	.jinja
_min_copier_version	9.0.0

All rendered files live under template/. Files ending in .jinja are rendered and written without the suffix. Files without that suffix are copied as-is unless their path contains Jinja variables.

Questions

Name	Type	Notes
project_name	str	Display name used in README, docs and UI
project_slug	str	Lowercase dash slug for directories and package metadata
pkg_slug	str	Lowercase underscore slug for Python import names
cli_name	str	Console script name
project_description	str	One-line project description
author_name	str	Package author metadata
author_email	str	Package author metadata
python_version	choice	3.12 or 3.13
desktop_framework	choice	pywebview (default), electron, tauri or none; selects which desktop app directory (if any) is generated and shapes the CLI's desktop/build desktop commands
database	choice	sqlite (default) or postgres; shapes the Docker stack, backend dependencies and .env.example
include_ai_saas	bool	Generates the optional AI Studio, provider-neutral runtime, durable jobs/worker, tenant ownership, uploads, credit ledger and Stripe credit packs
include_docker	bool	Generates docker-compose.yml, Dockerfiles, nginx.conf, .dockerignore and the stack CLI group
include_tunnel	bool	Adds the cloudflared quick-tunnel service and stack share (asked only when Docker is on)

Generated Python packages

Package	Purpose
<pkg_slug>_core	Domain models, ports, services and core errors
<pkg_slug>_backend	FastAPI app, SQLModel persistence, routes, migrations and adapter wiring
<pkg_slug>_cli	Typer CLI and development control plane
<pkg_slug>_desktop	pywebview shell and in-process request bridge (only with desktop_framework=pywebview; Electron/Tauri generate apps/desktop-electron/ / apps/desktop-tauri/ with a server.py sidecar instead)
<pkg_slug>_plugin_api	Plugin manifest, contract, health and registry helpers
<pkg_slug>_licensing	License providers, token signing and plan resolution
<pkg_slug>_ai_runtime	Provider-neutral generation domain, result types and job transitions (only with include_ai_saas=true)

Frontend package

apps/frontend is a React + Vite app. It uses a generated OpenAPI schema in src/client/schema.d.ts, a thin client wrapper in src/client/client.ts, and hand-written hooks in src/client/hooks.ts.

In browser mode, requests go to the backend over HTTP. In desktop mode, the same client dispatches through the pywebview bridge.

Extension points

Extension point	Where
Domain model	packages/core/src/<pkg_slug>_core/domain/
Core port	packages/core/src/<pkg_slug>_core/ports/
Core service	packages/core/src/<pkg_slug>_core/services/
Database row	apps/backend/src/<pkg_slug>_backend/adapters/db/models.py
Repository adapter	apps/backend/src/<pkg_slug>_backend/adapters/db/repository.py
API route	apps/backend/src/<pkg_slug>_backend/api/routes/
CLI command	apps/cli/src/<pkg_slug>_cli/main.py
Frontend view	apps/frontend/src/
Plugin	extensions/* or a separate package exposing <pkg_slug>.plugins entry points
Marketplace catalog	marketplace/catalog.json (or a hosted URL via APP_MARKETPLACE_URL)
Auth enforcement	apps/backend/src/<pkg_slug>_backend/auth.py (enforce_auth, require_admin)
AI provider	apps/backend/src/<pkg_slug>_backend/adapters/ai_provider.py (AIProvider implementations)
AI asset storage	apps/backend/src/<pkg_slug>_backend/adapters/asset_store.py
CI workflows	.github/workflows/ci.yml (tests, typed-client drift gate) and release.yml (tag-triggered desktop installers, when a desktop shell was selected)

Demo markers

The Resource Vault demo is marked with [demo] comments in mixed files and described in Make it yours. Treat this marker as the removal checklist when your own domain is ready.