Getting started
Installation
YASSB needs Node.js 20 or newer, or Bun. One command creates a working project.
Create a project
npx yassb-web new my-site
cd my-site
npm installyassb new creates the folder (the name is converted to kebab-case) and refuses to overwrite a folder that is not empty. The starter contains:
config/default.ts, the configuration, with one renderer registered;builder/renderers.ts, a typed renderer, andbuilder/styles.ts, how the stylesheet is compiled;src/app/pages/index.html, components, a JSON data source, a stylesheet and a TypeScript entry;AGENTS.mdandCLAUDE.md, the rules of the project for coding agents, with a "Setup" section describing the presets;yassb-weband@types/nodeas dev dependencies.
Choose a setup
Presets set up a common stack without starting from zero. Pick one per axis:
npx yassb-web new my-site --styles tailwind --scripts alpine --deploy github-pages| Flag | Presets |
|---|---|
--styles | sass (default), tailwind (Tailwind CSS 4), css (plain modern CSS), bootstrap (Bootstrap 5, from Sass), pico (Pico CSS, classless) |
--scripts | typescript (default), alpine (Alpine.js) |
--deploy | github-pages (GitHub Actions workflow, with relativeUrls on so the site works under /<repository>/), netlify (netlify.toml) |
A styles preset brings its own pages and components, written for that framework. The packages it needs are added to devDependencies: npm install installs them. Without flags the project uses Sass and TypeScript and has no deploy files.
Develop
npm run watchThe site is served on http://localhost:3000 and rebuilt on every change, with live reload. See Watch mode.
Build
npm run buildThe output goes to dist/public, minified and ready to upload to any static host. Run npm run check before deploying: it builds and validates the site.
Add YASSB to an existing folder
npm install --save-dev yassb-webCreate config/default.ts and src/app/pages/index.html; every other folder is optional and created on the first build. Add the scripts to package.json:
{
"scripts": {
"build": "yassb build",
"watch": "yassb watch",
"check": "yassb check"
}
}Note
With Bun, run the same commands with bunx yassb …. Builds are a little faster.