Skip to content
Sign inJoin waitlist

Install and run — Goeboek Next.js

Goeboek runs on Node.js with the usual Next.js commands: install the packages once, then start the development server and edit while the page updates by itself.

Node.js 20.9 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 is a good default; any editor works.
A browser Chrome, Edge, Firefox or Safari.
An internet connection The fonts Plus Jakarta Sans and Inter are downloaded from Google Fonts when the site builds, and the first time npm run dev runs. The site then serves them from your own domain.

No database, no account, no paid service. Every page is pre-rendered; only the three forms run on the server.

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:3000. Save a file and the page updates by itself.

Command What it does
npm run dev Development server with live reload
npm run build Production build — every page is pre-rendered as HTML, and the types are checked
npm start Serves the production build locally (run build first)
npm run lint Checks the code with ESLint. npm run build doesn’t run it, so run it yourself before you publish.
npx tsc --noEmit Checks the types without building. It reads the route types that npm run dev and npm run build generate, so run one of them once first.

Run npm run build before publishing. It checks the types, so it catches a missing field or a typo in a content file that the development server tolerates.

Goeboek is built on Next.js 16.4, which differs from older versions in ways you may notice:

  • Turbopack is the bundler for both npm run dev and npm run build; there is nothing to configure.
  • next lint no longer exists: npm run lint runs ESLint directly (eslint.config.mjs), which is why npm run build doesn’t lint.
  • An AGENTS.md may appear. If you work with an AI coding assistant, npm run dev adds an AGENTS.md (and a CLAUDE.md that points to it) to the project root, telling the assistant to read the Next.js documentation bundled in node_modules/next/dist/docs/ before it writes code. That is Next.js’s own behaviour: keep the files if the assistant helps you, delete them if not; the site doesn’t use them.
  • Server actions carry the three forms, so the site needs a host that runs Node.js: it can’t be exported as plain static files (Going live).
src/
app/ one folder per route; also the browser icons, sitemap.ts and robots.ts
page.tsx Home: the hero, Featured Properties, About, the call to action, the latest posts
property/page.tsx /property: every property, six at a time
type/[type]/ /type/sell and /type/rent
location/[slug]/ /location/<slug> (one listing per location)
property-category/[slug]/ /property-category/<slug> (one listing per category)
agent/[slug]/ /agent/<slug> (one page per agent)
property/[slug]/ /property/<slug> (one page per property)
blog/ /blog and /blog/<slug> (one page per post)
about/, contact/ /about, /contact
add-property/ /add-property (the form to submit a property)
success-scheduled/, success-add-property/ the two thank-you pages
not-found.tsx the 404 page
style-guide/ every component with examples (noindex; delete the folder to remove it)
layout.tsx the fonts, the site's metadata, the sticky header and the footer
icon.png the browser icon (192 × 192)
apple-icon.png the icon on a phone's home screen (180 × 180)
globals.css Tailwind and the design tokens
components/
sections/ the sections of every page (Hero, PropertyListing, PropertyOverview, TourForm, …)
site/ Header (with the phone menu) and Footer
content/
site.ts name, title, description, domain, logo, the header's links and buttons, the contact
details, the social links and the footer
sections.ts copy shared by several pages: the call to action, the property cards' labels, the
listing filter, the rating label
pages/*.ts the copy of every page (home.ts, property.ts, about.ts, …)
collections/*.ts properties, agents, locations, categories, posts and testimonials
routes.ts every URL in the site, in one place
types.ts the shape of all content
design-system/ tokens and reusable components — see its own README
lib/
content.ts the only way pages read collections (swap this for a CMS, see cms.md)
listing.ts what the five listing pages share (the cards, the filter, their metadata)
to-ui.ts turns content into what the cards, the agent card and the filter show
actions.ts what the three forms send
forms/ form delivery and its providers (console, webhook, Mailchimp, Resend), with a README
meta.ts the canonical link, share card and title of a page
format.ts dates, prices and numbers
public/
images/ photos, the logo's mark and the two success illustrations (/images/<file>)
.env.example the settings of the forms (copy it to .env.local)

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

  • Install the Tailwind CSS IntelliSense and ESLint extensions for class name and code hints.
  • The project is TypeScript: your editor tells you when a content file is missing a field, 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/, public/ and theme.css where possible. When a new version of the template ships, you can copy your content folder into the new release instead of re-applying changes by hand. CHANGELOG.md lists what changed.