Install and run — Brickfolio Astro
Brickfolio is a standard Astro project: install the packages once, then start the development server and edit while the page updates by itself.
What you need
Section titled “What you need”| 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 when the site builds: the fonts ship as files in
src/assets/fonts/. The site builds to static files you can host anywhere; only the forms’ optional server mode needs a
server (Forms).
Install
Section titled “Install”Unzip the template, open the folder in a terminal and run:
npm installThis downloads the packages listed in package.json into node_modules/. It takes a few minutes the first time.
npm run devOpen http://localhost:4321. Save a file and the page updates by itself.
The commands
Section titled “The commands”| 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.
What is in the folder
Section titled “What is in the folder”src/ pages/ one file per URL index.astro Home: the profile card beside the column of sections and the footer project/[slug].astro /project/<slug>, one page per project blog/[slug].astro /blog/<slug>, one page per post 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, fonts) and the sticky header components/ sections/ Home's sections (Profile, Projects, Services, Testimonials, …), the project and post articles and "More Projects" / "More Posts" (MoreItems.astro) site/ Header (with the phone menu and header.ts, its script), Footer (the newsletter box and the copyright line), PageColumn and CloseBar (the project and post pages) content/ site.json name, title, description, domain, e-mail, logo, the header's links and button, the social links, the newsletter box and the copyright line pages/*.json the copy of Home (home.json), of the project and post pages and of the 404 page collections/*.json projects, services and posts 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 (props in types.ts) and their browser scripts (scripts/) assets/images/ the photos and client logos used by the content (/images/<file>); Astro resizes and compresses them assets/fonts/ Inter and Fragment Mono 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 to-ui.ts turns content into what the cards, the social links and the tickers show forms/ form delivery (demo, static and server modes) and its guide meta.ts the browser title and the canonical link of a page format.ts dates and descriptionspublic/ files served as they are: the icons, the social networks' marks (icons/) and cv.pdfastro.config.mjs the site's address (from site.json), page files, the fonts, the forms integrationvercel.json clean addresses on Vercel.env.example the form settings, to copy to .envDelete src/pages/style-guide.astro if you don’t want the component gallery on your site; nothing else depends on it.
Editor tips
Section titled “Editor tips”- Install the Astro and Tailwind CSS IntelliSense extensions. VS Code suggests the first when you open the
folder (
.vscode/extensions.json). npm run checkreads 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.
Updating later
Section titled “Updating later”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.