Install and run — Brickfolio Next.js
Brickfolio 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.
What you need
Section titled “What you need”| 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 Inter and Fragment Mono 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 two forms run on the server.
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:3000. 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 |
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.
Good to know about Next.js 16
Section titled “Good to know about Next.js 16”Brickfolio 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 devandnpm run build; there is nothing to configure. next lintno longer exists:npm run lintruns ESLint directly (eslint.config.mjs), which is whynpm run builddoesn’t lint.- An
AGENTS.mdmay appear. If you work with an AI coding assistant,npm run devadds anAGENTS.md(and aCLAUDE.mdthat points to it) to the project root, telling the assistant to read the Next.js documentation bundled innode_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 two forms, so the site needs a host that runs Node.js: it can’t be exported as plain static files (Going live).
What is in the folder
Section titled “What is in the folder”src/ app/ one folder per route; also the browser icon, sitemap.ts and robots.ts page.tsx Home: the profile card beside the column of sections and the footer project/[slug]/ /project/<slug> (one page per project) blog/[slug]/ /blog/<slug> (one page per post) not-found.tsx the 404 page style-guide/ every component with examples (noindex; delete the folder to remove it) layout.tsx the font, the site's metadata and the sticky header 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/ Home's sections (Profile, Projects, Services, Testimonials, …), the project and post articles and "More Projects" / "More Posts" (MoreItems.tsx) site/ Header (with the phone menu), Footer (the newsletter box and the copyright line) and PageColumn (the column and the close button of the project and post pages) content/ site.ts name, title, description, domain, e-mail, logo, the header's links and button, the social links, the newsletter box and the copyright line pages/home.ts every section of Home: the profile card, the titles and texts, the testimonials, the experience, the client logos, the contact form and the questions pages/project.ts the labels of a project page and "More Projects" pages/post.ts the labels of a post page and "More Posts" pages/not-found.ts the 404 page collections/*.ts projects, services and posts 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) to-ui.ts turns content into what the cards, the social links and the tickers show actions.ts what the two forms send forms/ form delivery and its providers (console, webhook, Mailchimp, Resend) meta.ts the canonical link, share image and title of a page format.ts dates and descriptionspublic/ images/ photos (the profile photo is also the logo's) and the client logos (/images/<file>) icons/ the social networks' marks shown on hover cv.pdf the CV behind "Download CV".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.
Editor tips
Section titled “Editor tips”- 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.
Updating later
Section titled “Updating later”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.