Introduction

Getting Started

Requirements

Node.js 24 or later (the exact version is pinned in .node-version).
Bun 1.3 or later, used for installing packages, bundling and scripts.
Git, and a Chromium browser for the Playwright tests. bun install doesn't download one, so point PLAYWRIGHT_CHROMIUM_EXECUTABLE at an existing browser if needed.

Install and run

Clone the private repository you were invited to, then:

bun install
bun run dev

The development server watches the CSS, JavaScript and content, and serves the site at http://localhost:4173. Set PORT to use another port. Stop it with Ctrl-C.

bun install also points Git at the hooks in .githooks/, so the quality gates run on your first commit.

Make your first change

Open src/_data/site.defaults.json and change name to your startup's name.
Save. The header, footer, page titles and structured data all update.
Open src/_data/i18n.js and edit hero.title in both en and fr.

Build for production

bun run build

This writes a minified, fingerprinted build to _site/. Only hashed CSS and JavaScript bundles are published, so they can be cached forever.

Next steps

Basic usage covers pages, layouts and translations.
Configuration covers branding, keys, pricing and payments.