Skip to content
Sign inJoin waitlist

Balancee documentation — Astro

Everything you need to take Balancee 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, videos, services, case studies, posts, the team and legal pages — no CMS needed
Making it look like your brand Colours, the logo and the “B” 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, adding, removing and reordering pages and sections
Forms Making the contact form and the newsletter box 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
  • 11 kinds of page, 33 addresses:
    • Home, About, Services, Portfolio, Blog, Contact and the 404 page;
    • a page for each of the 8 services, the 8 case studies, the 9 blog posts and the 2 legal pages (Terms of Service, Privacy Policy), built from the collections (Pages and sections).
  • 4 collections in src/content/collections/: services (services.json, 8), case studies (portfolio.json, 8), posts (posts.json, 9) and legal pages (legal.json, 2). The timeline, the awards and the team are page copy in src/content/pages/about.json.
  • 2 forms: the contact form (“Tell us about your project.”) on Contact and Services, and the newsletter box in the footer of every page. They run in demo mode until you give them 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 client logo ticker, a testimonial video that plays on click, a case study accordion on Home, team cards with a bio on hover, load-on-scroll lists for the Portfolio and the Blog, and the numbered steps of “How we work”.
  • A fixed header with a filled pill on the current page, and a menu that grows from the bar on phones.
  • Motion in the components (hovers, the video players, the ticker, the accordion, the lists that load as you scroll), 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.xml and robots.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 three Home videos play from the Pexels website: replace them (Editing the content). The wordmark, the “B” icon and the client logos are drawn for the template.
  • These docs (docs/), the forms guide (Forms reference), the design system’s reference (Balancee design system (Astro)), CHANGELOG.md and LICENSE.md.
Terminal window
npm install
npm run dev
  1. Open http://localhost:4321.
  2. Put your name, title, description and domain in src/content/site.json, and your menu, contact details (e-mail, phone, address, hours), social links and footer in the same file.
  3. Replace the photos in src/assets/images/ (keep the file names and you are done) and write an alt for each in the content (Editing the content); put your own videos in public/ and their paths in video.src (Editing the content).
  4. Replace the wordmark (Making it look like your brand), the browser icons in public/ (icon-light.svg, icon-dark.svg, apple-icon.png) and the share image (public/opengraph-image.png).
  5. Edit the page copy in src/content/pages/, and your services, case studies, posts and legal pages in src/content/collections/. Search for “Balancee”, “Emma Carter” and “hello@example.com”: the demo’s name, founder and e-mail are written in many places (Editing the content). The legal pages say [Your Company Name] and [URL] where yours go.
  6. Point the forms at your inbox: Forms.
  7. Deploy: Going live.

Nothing else is required: the site has no database, no account to create and no paid service to run.

  • Content is data. All text and every collection item live in src/content/, as JSON. Pages read the collections through src/lib/content.ts, and src/content.config.ts says 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 springs in src/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/ or src/components/, and is shown at /style-guide on your own site.
  • Some blocks repeat. The closing call-to-action band, “How we work”, the consultation prompt and the contact form’s fields appear on several pages from one file, src/content/pages/shared.json; the other copy lives in each page’s file (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 in src/components/site/) whose init*() function the component’s <script> calls, and hovers are CSS (Making it look like your brand).