Goeboek documentation — Astro
Everything you need to take Goeboek for Astro from the downloaded folder to a published real estate site. Read in this order, or jump to what you need.
| Guide | What it covers |
|---|---|
| Install and run | Requirements, install, the commands, what is in each folder |
| Editing the content | Editing your details, the copy of every page, properties, agents, locations, categories, posts and testimonials, images — no CMS needed |
| Making it look like your brand | Colours, the logo and the browser icon, fonts, text styles, spacing, motion, components, the style guide |
| Pages and sections | The header, the sections of every page with a map of each, the 58 addresses, adding, removing and reordering sections and pages |
| Forms | Making the contact, tour and Add property forms deliver to you |
| Using a headless CMS | The collections and their fields, for connecting Sanity, Payload, Strapi, Directus or any other headless CMS |
| Going live | Pre-launch checklist, deploying, domains, what to do after launch |
| Troubleshooting and questions | Errors, questions and answers |
What is in the package
Section titled “What is in the package”- 15 kinds of page, 58 addresses:
- Home, Blog, About, Contact, Add property, the two thank-you pages and the 404 page;
- the listings: every property, the two types (to buy, to rent), and one page per location, category and agent;
- a page for each of the 21 properties and the 12 posts, built from the collections (Pages and sections).
- 6 collections in
src/content/collections/: properties (properties.json, 21), agents (agents.json, 4), locations (locations.json, 6), categories (categories.json, 5), posts (posts.json, 12) and testimonials (testimonials.json, 12, shown on Home and About). - 3 forms: Contact, “Schedule tour” on every property page and Add property. They post to a form service or a webhook from any static host, or, in server mode, to the site’s own route with four providers (a log, a webhook, Mailchimp, Resend). The tour and Add property forms open their thank-you pages once sent.
- A sticky header with the menu and two buttons, a menu that opens under it on phones, and a footer with the contact details, link columns and social links on every page.
- A listing filter beside every listing: links to every type, category, location and agent, folded behind a toggle on phones.
- Motion from the original design (slideshows, the property cards’ photos on hover, flip buttons, rolling labels),
with reduced-motion support, and a style guide of every component at
/style-guide. - Search and sharing: a title, a description and a canonical link for every page, share cards, a browser icon and a
home-screen icon,
sitemap.xmlandrobots.txt. - A static build:
npm run buildwrites plain files todist/that any host can serve. - Placeholders: the photos in
src/assets/images/are grey placeholders that show their sizes (the demo uses photos from Unsplash and Pexels, or made for the template, which can’t be sold with a template). - These docs (
docs/), the forms guide (Forms reference),CHANGELOG.mdandLICENSE.md.
In a hurry: the first 15 minutes
Section titled “In a hurry: the first 15 minutes”npm installnpm run dev- Open http://localhost:4321.
- Put your name, title, description and domain in
site, and your address, phones, e-mail, opening hours and social links incontactandsocials, insrc/content/site.json. - Write Home’s texts in
src/content/pages/home.jsonand the shared call to action insrc/content/sections.json. - Replace the photos in
src/assets/images/(keep the file names and you are done). - Set your logo and browser icon (Making it look like your brand).
- Write your properties, agents, locations, categories, posts and testimonials in
src/content/collections/(Editing the content). Search for “Goeboek”: the demo’s name is written in many places. - Point the three forms at your inbox or your tools: Forms.
- Deploy: Going live.
Nothing else is required: the site has no database, no account to create and no paid service to run.
How this template is put together
Section titled “How this template is put together”- Content is data. All text and every collection item live in
src/content/, checked againstsrc/content/schemas.ts. Collections are loaded bysrc/content.config.tsand pages read them throughsrc/lib/content.ts, which is why swapping in a CMS later touches one or two files, not the whole site. - References by slug. A property names its category, location and agent by their
slug; the listings, the filter and the cards look them up, so renaming an agent changes every card at once. - No framework in the browser. Pages are static HTML; the interactive parts are small scripts in
src/design-system/scripts/, and hovers are CSS. - Design is tokens. Colours, breakpoints and easing are in
src/design-system/theme.css; text styles, springs and slideshow speeds insrc/design-system/tokens/. Change a token and every page follows (Making it look like your brand). - Components are shared. Every card, button, slideshow, filter and form is in
src/design-system/, the sections insrc/components/, and all are shown at/style-guideon your own site.
Getting help
Section titled “Getting help”- Your licence terms: License.
- What changed in each release: Changelog.
- Support and updates: https://framebrick.co/support.
- Want it done for you? Marcframe, the studio behind this template, updates templates to your needs, builds custom templates and designs new sites. It’s also on Contra.