Templates

A template is a working voidbase project somebody publishes so other people can start from it instead of from an empty directory. It stays in their repository under their licence; copying it gives you your own.

Starting from one

Every listed template is a public GitHub repository with Use this template switched on, so starting is pressing that button and getting your own copy. Browse them in the marketplace, and then follow the page for whichever shape it is: a voidbase project or a stack app. Both of those pages have a section on starting from a template rather than from nothing.

Taking a template does not tie you to it. What you get is a repository, and from there it is an ordinary project: run it locally, make instances of it, or deploy it from a push.

What makes one worth publishing

A template is not a snippet and not a tutorial. Someone copies it, runs one command, and sees something working; anything short of that costs them more than starting fresh would. The three we list are all real projects that serve real traffic rather than examples written for the listing.

my-template/
├─ pb_hooks/        or vb_hooks/ in a stack app: the behaviour someone inherits
├─ pb_migrations/   the collections, so the schema arrives with the code
├─ pb_secrets/      what has to be configured, declared with safe defaults
├─ README.md        what someone gets, and the first command to run
└─ LICENSE          so people know what they may do with it

The pieces that matter most are the least interesting ones. Migrations mean the schema arrives with the code instead of being a setup step. Declared secrets with defaults mean it runs before anything is configured. A README that says what someone gets is what makes the difference between a template and a repository.

Publishing yours

A submission is a GitHub issue, an automated audit reports on the repository before anyone decides, and a maintainer lists it. The seven checks it runs, and which four of them block, are on the publishing page.

One thing worth knowing before you spend time on it: turn on Template repository in your repository settings. Without it, Use this template does nothing, and that button is the only way anyone can currently use what you published.