Skip to content
Sign inJoin waitlist

Install and run — Kendi Astro

Kendi is a standard Astro project: install the packages once, then start the development server and edit while the page updates by itself.

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.

No database, no account, no paid service, and no download while the site builds: the font Inter ships with the template (src/assets/fonts/). The site builds to static files you can host anywhere; only the forms’ optional server mode needs a server (Forms).

Unzip the template, open the folder in a terminal and run:

Terminal window
npm install

This downloads the packages listed in package.json into node_modules/. It takes a few minutes the first time.

Terminal window
npm run dev

Open http://localhost:4321. Save a file and the page updates by itself.

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.

src/
pages/ one file per URL
index.astro Home
about.astro /about
blog.astro /blog (Articles); blog/[slug].astro is one page per post
category.astro /category (every category); category/[slug].astro is one page per category
author.astro /author (every author); author/[slug].astro is one page per author
contact.astro /contact, with the contact form
legal/[slug].astro /legal/<slug>, one page per legal text
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, font), the header and the footer
components/
sections/ the sections pages are made of (HeroSection, HomeMainSection, Sidebar, NewsletterSection, …)
site/ Header (with the Categories menu and the tablet and phone menus, and header.ts, its script), Footer
content/
site.json name, title, description, domain, menu, the Categories menu, contact details, socials, the
sponsored ad, the sidebar, the newsletter and the footer
pages/*.json the copy of one page each, including its title and description (contact.json also holds the
contact form, home.json the rules of Home's lists)
collections/*.json posts, categories, authors, legal pages, the team, the footer's photo grid
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 (scripts/)
assets/
images/ photos, the logo and the sample ad's logo, used by the content as /images/<file>; Astro
resizes and compresses the photos
fonts/ Inter, as one variable font file
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
sidebar.ts the sidebar's lists and the newsletter band's photos
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 and search descriptions
to-ui.ts turns collection items into what the components show
public/ files served as they are: the icons and the share image
astro.config.mjs the site's address (from site.json), clean file names, the font, the forms integration
vercel.json clean addresses on Vercel
.env.example the form settings, to copy to .env

Delete src/pages/style-guide.astro if you don’t want the component gallery on your site; nothing else depends on it.

  • Install the Astro and Tailwind CSS IntelliSense extensions. VS Code suggests the first when you open the folder (.vscode/extensions.json).
  • npm run check reads your collections against the schemas: a missing field is reported with its collection, its 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.

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.