Project outline

Sausage site engine (project outline)

Index

  • What it is
  • How it works
  • Where it runs
  • Key commands
  • Status

What it is

  • Client-agnostic engine for small-business static websites.
  • Builds HTML from one site.config.json; client data lives only in config and env vars, never in engine source.
  • Words: client = the business that runs a site; agency = us.

How it works

  • engine/: build system, browser assets, Worker handlers (contact, admin, analytics).
  • config/, layout/, partials/, static/, custom.css: client-owned inputs.
  • scripts/, tests/, docs/: tooling, Vitest suite, guide and ADRs.
  • site/: build output, never hand-edited.
  • Hard rules: zero client literals in engine/, fail loudly on missing env vars, security headers on every HTML response, file header block on every new .js.
  • Optional capabilities (analytics, contact form, blog search) are independently enable-able.

Where it runs

  • Cloudflare Pages + Workers.
  • Upgrade order: dev site, then client staging, then production.
  • Never push or deploy without the agency's go-ahead.

Key commands

  • npm test: Vitest suite incl. ESLint; must pass before committing.
  • npm run build: build the static site.
  • npm run test:blog-only: whole suite as a blog-only client.
  • Merge: branch, test, build, then git merge --no-ff into main. No PRs.

Status

  • Engine version 2.83.0 (ENGINE_VERSION).
  • Releases are logged in CHANGELOG.md with Upgrade: and Action: lines.