What is this?
This is a Next.js starter boilerplate pairing Next.js 16, React 19 and Tailwind CSS 4, built around a strict set of build conventions documented in CONVENTIONS.md.
Is this a library I install, or a starter repo I clone and build on?
It is a starter/boilerplate repo you clone and build your own project on top of, not a package you npm install into an existing app.
How do I get it running?
Clone the repo, then run npm run dev to start the dev server, npm run build for a production build, and npm run start to serve that build.
What do I need before building on it?
Just Node/npm to run the scripts — and before writing any component, section, or page you must read CONVENTIONS.md, since the whole repo is built around it.
Can I just start adding components without reading anything first?
No — CONVENTIONS.md is described as the entire spec for how the repo is built, so it has to be read before touching any component, section, or page.
What does npm run to:avif do?
It converts an image to AVIF format and reports its inline byte cost, which ties into the repo's image-optimization rule (rule 11).
What is AGENTS.md for?
It holds Next.js version notes aimed at AI coding agents working in this repo, separate from the human-facing CONVENTIONS.md.
Why is the Rive animation gated behind LCP?
OPTIMIZATION.md documents measurements showing why the asset's Rive loading is delayed until after Largest Contentful Paint, to keep page performance intact.
What are similar projects?
sales-crm, react-redux-universal-hot-example, saas-starter, Next-js-Boilerplate, react-starter-kit, cult-ui, svelte, core
Which topics is it in?
starter-kit, eslint, seo, boilerplate, ssr, template, web-framework, tailwindcss, image-processing, nextjs, animation, css