A working acme/starter module scaffold. It writes log entries through an automation sink and Block, persists them with migrations, and exposes a status API and Vue web component. Lua harnesses exercise SQLite and PostgreSQL.
Create a repository from this template, then initialize its identity:
make init ORG=your-org MODULE_NAME=your-module TITLE="Your module"
make setup
make lint typecheck build test-ui testmake init also accepts NAMESPACE, TAG, and GITHUB_OWNER (default: ORG). It runs once per checkout. Commit the rebuilt static/ bundle with your source changes.
The sink and Block announce committed writes on acme.starter.changed through
the host's kickside.contract:realtime binding. The page refetches its status
endpoint on that topic and when the host shows the retained component again.
make test-ui checks notification refresh, return visits, and overlapping reads.
Run the PostgreSQL suite before changing SQL or migrations. make postgres-up starts PostgreSQL on port 5433 with an empty test database:
make postgres-up
make test-pg
make postgres-downmake release-check runs every gate and a publish dry run. Releases go through the GitHub Release Please workflow, which opens a reviewed release proposal and publishes only after it merges.
The Makefile owns the commands. The bundled developer handbook is an exact copy of the canonical handbook shipped by KickSide; make sync-handbook updates it and make check-handbook detects drift. See the module authoring guide for contracts, requirements, and application integration.
License: MIT · Third-party notices.