Install and run — Cerette Astro
Cerette is a standard Astro project: install the packages once, then start the development server and edit while the page updates by itself.
What you need
Section titled “What you need”| Node.js | 22.12 or newer (node -v). Download at https://nodejs.org — the LTS build is fine. |
| A package manager | npm comes with Node. pnpm, yarn and bun work too. |
| A code editor | VS Code with the Astro extension is the smoothest; any editor works. |
| A browser | Chrome, Edge, Firefox or Safari. |
| An internet connection | The fonts (Plus Jakarta Sans, Marcellus, Inter) are downloaded from Google Fonts when the site builds, and when npm run dev starts. The site then serves them from your own domain. |
No database, no account, no paid service. The site builds to static files you can host anywhere; only the forms’ optional server mode needs a server (Forms).
Install
Section titled “Install”Unzip the template, open the folder in a terminal and run:
npm installThis downloads the packages listed in package.json into node_modules/. It takes a few minutes the first time.
npm run devOpen http://localhost:4321. Save a file and the page updates by itself.
The commands
Section titled “The commands”| Command | What it does |
|---|---|
npm run dev |
Development server with live reload |
npm run build |
Builds the static site into dist/ — every page is pre-rendered as an HTML file |
npm run preview |
Serves dist/ locally, as a host would (run build first) |
npm run check |
Checks the types, the content against its schemas and the Astro files |
Run npm run check and npm run build before publishing, then look at the result with npm run preview. check
catches a missing field or a typo in a content file that the development server tolerates, and the preview is the real
thing: the built pages, served as a host serves them.
What is in the folder
Section titled “What is in the folder”src/ pages/ one file per URL index.astro Home about.astro /about project.astro /project (every project) project/[slug].astro /project/<slug>, one page per project service.astro /service (every service) service/[slug].astro /service/<slug>, one page per service blog.astro /blog (every post, newest first) blog/[slug].astro /blog/<slug>, one page per post contact.astro /contact, with the inquiry form legal/[slug].astro /legal/<slug>, the privacy policy and the terms 404.astro the page shown for an unknown address sitemap.xml.ts the sitemap, built from routes and collections robots.txt.ts robots.txt style-guide.astro every component with examples (noindex; delete it to remove the page) layouts/Layout.astro the <head> of every page (title, description, share card, icons), the header and the footer components/ sections/ the sections pages are made of (HomeHero, ProjectStory, InquiryForm, …) site/ Header (with the phone menu), header.ts (its script), Footer style-guide/ the helpers of the style guide page content/ site.json name, title, description, domain, menu, the header's button, contact details, social links and the footer pages/*.json the copy of one page each, including its title and description (forms.json holds the two forms, cta.json the closing call to action, project.json, service.json and legal.json the words of the pages built from a collection) collections/*.json the projects, the services, the testimonials, the team, the posts and the legal pages routes.ts every URL in the site, in one place schemas.ts the fields each kind of item has, and which are required content.config.ts how the collections are loaded (the file to change for a CMS, see cms.md) design-system/ tokens, components and their browser scripts — see its own README assets/images/ the photos used by the content (/images/<file>); Astro resizes and compresses them styles/ global.css imports Tailwind and the theme integrations/ forms.ts adds the form route when the forms run in server mode rescan.ts development only: makes the classes of a file you add reach the stylesheet lib/ content.ts the only way pages read collections forms/ form delivery (demo, static and server modes) and its guide meta.ts the browser title, the canonical link and the share image of a page format.ts dates, search descriptions and phone links image-size.ts reads the size of an image when the site builds to-ui.ts turns collection items into what the cards showpublic/ files served as they are: the icons, the share image and the grain texture (images/grain.png)astro.config.mjs the site's address (from site.json), clean file names, the fonts, the forms integration.env.example the form settings, to copy to .envDelete src/pages/style-guide.astro (and src/components/style-guide/) if you don’t want the component gallery on
your site; nothing else depends on it.
Editor tips
Section titled “Editor tips”- Install the Astro and Tailwind CSS IntelliSense extensions. VS Code suggests the first when you open the
folder (
.vscode/extensions.json). npm run checkreads your collections against the schemas and the page copy against the sections that use it: a missing field is reported with its file (or its collection and item) and its name, before you open the browser.- Search across files (
Ctrl/Cmd + Shift + F) for a phrase you see on the demo site to find the file that holds it.
Updating later
Section titled “Updating later”Keep your edits in src/content/, src/assets/images/, public/ and theme.css where possible. When a new version of
the template ships, you can copy those into the new release instead of re-applying changes by hand. CHANGELOG.md
lists what changed.