Catchup documentation — Astro
Everything you need to take Catchup for Astro from the downloaded folder to a published 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 text, images, projects, services, testimonials, posts and legal pages — no CMS needed |
| Making it look like your brand | Colours, the logo, fonts, text styles, spacing, motion, components, the style guide |
| Pages and sections | The header, the sections of every page with a map of each, adding, removing and reordering pages and sections |
| Forms | Making the contact form 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”- 11 kinds of page, 28 addresses:
- Home, About, Work, Services, Blog, Contact and the 404 page;
- a page for each of the 4 projects, 4 services, 12 posts and 2 legal pages, built from the collections (Pages and sections).
- 5 collections in
src/content/collections/: the work (4 projects), the services (4, each with a Per Project and a Per Month plan), the testimonials (10), the blog posts (12) and the legal pages (2). - 1 form: the inquiry form on Contact (Name, Email, Services, Budget, Project Timeline, Message). It runs in demo mode until you give it a destination: a form service or webhook on any static host, or the site’s own route with four ways to deliver (a log, a webhook, Mailchimp, Resend).
- A Home page that moves: an intro that plays once per visit, a full-screen slideshow of your projects, the client logos, faces and testimonials moving sideways, and numbers that count up.
- A header that sits over Home’s hero and comes back fixed once the hero is scrolled past, fixed on every other page, with a menu that opens under the bar on phones.
- Motion in the components (titles appearing word by word, blocks rising into view, the hovers), 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, icons for light and
dark browser themes,
sitemap.xmlandrobots.txt. - Placeholders: the photos in
src/assets/images/are grey placeholders that show their sizes (the demo uses photos from Unsplash and Pexels, which can’t be sold with a template). The Catchup logo and the client logos are drawn for the template. - These docs (
docs/), the forms guide (Forms reference), the design system’s reference (Catchup design system),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
src/content/site.json, and your menu, contact details, booking link, social links and footer in the same file. - Replace the photos and client logos in
src/assets/images/(keep the file names and you are done) and write analtfor each in the content (Editing the content). - Replace the logo (Making it look like your brand), the browser icons in
public/(icon-light.png,icon-dark.png,apple-icon.png) and the share image (public/opengraph-image.png). - Edit the page copy in
src/content/pages/, and your projects, services, testimonials, posts and legal pages insrc/content/collections/. Search for “Catchup”: the demo’s studio is named in the copy, the legal pages and the footer. - Point the contact form at your inbox: 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/, as JSON. Pages read the collections throughsrc/lib/content.ts, andsrc/content.config.tssays where each collection comes from, which is why swapping in a CMS later touches one file, not the whole site. - Design is tokens. Colours, breakpoints and easing curves are in
src/design-system/theme.css; text styles and motion timings insrc/design-system/tokens/. Change a token and every page follows (Making it look like your brand). - Components are shared. Every button, card, form field and section is in
src/design-system/orsrc/components/, and is shown at/style-guideon your own site. - Collections feed several places. The services and the projects also fill the footer’s columns, the testimonials appear on Home, About, every service and every project, and the newest posts on Home (Pages and sections).
- No framework in the browser. The pages are static HTML. Each interactive part has a small TypeScript script in
src/design-system/scripts/(the header’s is insrc/components/site/) whoseinit*()function the component’s<script>calls, and hovers aredata-hover/data-motionattributes played byscripts/hover.ts(Making it look like your brand).
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.