🚀 terox-templates

Official Weburz template catalogue for the Terox scaffolder.

---

✨ One command, fresh repo

terox scaffold weburz/terox-templates/<template> --output ./my-project

Pick a starter, answer a handful of prompts, and you've got a fully-wired Weburz-flavoured repo: pnpm, vitest, eslint flat config, MIT licence, GitHub Actions CI, Dependabot, CODEOWNERS, pre-commit hooks, and a changelogen-driven release flow.

📦 Templates

	Template	What it gives you
🟦	npm-package	TypeScript npm package — unbuild, vitest, eslint flat config, GitHub Actions QA + pnpm publish --provenance on v* tags.
🟩	nuxt-module	Nuxt 4 module — @nuxt/module-builder, runtime component, playground app deployed to GitHub Pages, vitest e2e fixture.
📚	docs-site	Nuxt 4 documentation site — @nuxt/content + @nuxt/ui v4 + Tailwind v4, Weburz brand colors, self-hosted Umami analytics, ESLint + Prettier, auto-deploy to GitHub Pages.

More on the way as Weburz grows the catalogue.

🎛️ Variables

Every template ships a terox.json declaring the variables it prompts for — package name, description, author, GitHub owner/repo, license year, etc. Press Enter at any prompt to accept the default, or skip prompts entirely with --set:

terox scaffold weburz/terox-templates/npm-package \
  --output ./foo \
  --set PackageName=@weburz/foo \
  --set GitHubRepo=foo \
  --non-interactive

🧪 Try a template locally

terox scaffold accepts a local directory path in place of a GitHub ref — useful while iterating on a template:

terox scaffold ./npm-package --output /tmp/scratch

➕ Adding a new template

See CONTRIBUTING.md — it covers prerequisites, terox.json manifest syntax, the {{ }} escape gotcha, render-checking, and the three places to update when adding a new template directory.

TL;DR for the impatient:

cp -r npm-package my-new-template     # or whichever existing template is closest
$EDITOR my-new-template/terox.json    # edit the variables + description
task render -- my-new-template        # render-check with defaults

🧰 Built on

• 🦫 Terox — the Weburz project scaffolder
• 🔧 Go text/template — the templating engine under the hood
• 📦 pnpm 11 — the package manager every starter assumes

📜 Licence

MIT © Weburz