Publish a template
A template is a public repository somebody can start a voidbase project from. It stays yours, in your account, under your licence. Listing it points people at it.
What makes one worth listing
A template is not a snippet. Someone clicks Use this template, gets a repository, and should be able to run it within a minute and see something working. The three we list first are all real projects that serve real traffic rather than demos written to look good: the public demo as a voidbase project, and this site and the marketplace as stack apps.
# a template is an ordinary voidbase project, so start one the ordinary way
voidbase init my-template
cd my-template
# make it worth starting from: collections, a hook or two, something that runs
voidbase serve --devBefore you submit
- The repository is public.
- It has a licence GitHub can identify. A
LICENSEfile GitHub cannot recognise counts as none, which is a real trap: an explanatory paragraph inside the licence text is enough to break detection. - It has a README saying what someone gets from starting with it.
- Template repository is switched on in its settings. Without that, Use this template does nothing, and that button is the only way anyone can use what you listed.
What the audit checks
It runs when you open the issue and comments with what it found. Every check is deterministic and reported with its reason, and all of them appear on the listing, so you can disagree with any one of them by reading it.
| Check | What it means | |
|---|---|---|
public repository | It exists and is reachable without signing in. | blocks |
not archived | An archived repository stops getting fixes. | blocks |
has a licence | GitHub can identify one. Reported rather than fatal, because whether an unlicensed repository is a problem for you is not ours to decide. | reported |
has a commit to point at | The default branch reads, and its tip is recorded with the listing so a later change is visible as a change. | blocks |
looks like a voidbase project | One of void.json, vb_hooks, vb_migrations, pb_hooks, pb_migrations, vb_secrets or pb_secrets is in the root. | blocks |
has a README | There is something to read before cloning it. | reported |
nothing obviously alarming | The files it reads contain no shell-piped downloads, eval, process spawning, or anything shaped like a credential. | reported |
The audit does not run your code. It reads a handful of files at one commit on one day, and the repository can change the minute after. It cannot tell anyone a template is safe, only that nothing it knows to look for was there. There is no model in the blocking path, and if an advisory pass is ever added it will be labelled advisory and will not be able to fail a submission on its own.
Submitting
- Open the template submission form.
- The audit comments within a minute or two. If it flags something, edit the issue: that runs it again.
- A maintainer decides. Accepted listings are committed to the registry and appear after the next deploy.
A listing can be removed if the repository disappears, becomes something other than what was listed, or turns out to be someone else's work. If you would rather ask before you spend time on it, we are on Discord.
Fix it yourself. The link below opens this file in GitHub's editor and forks the repository for you if you need one, and your change becomes a pull request without leaving the browser.