Getting started
Fill in your site identity and run the project locally.
1. Set your site identity
Open src/config/site.ts and replace the PLACEHOLDER_* values with your real
product name, tagline, description, and contact details. This file is the single
source of truth; every page, sitemap entry, and structured-data block reads from
it. Do not hardcode your domain or product name anywhere else.
Then copy .env.example to .env and set NEXT_PUBLIC_SITE_URL to your
canonical URL.
2. Run it
bun install
bun run devOpen http://localhost:3000.
3. Add content
- Blog posts live in
content/blog/*.mdx. Include a## Frequently asked questionssection so FAQ structured data is generated. - Docs pages live in
content/docs/*.mdxand are listed inmeta.json. - Glossary, comparison, and guide pages are data-driven arrays in
src/lib/content/. Each array ships with one seed entry to copy.
4. Check and build
bun run check:placeholders
bun run buildcheck:placeholders fails if any leftover mustache-style {{...}} placeholder
tokens remain in src/ or content/ (the templates/ directory is exempt -
those files are meant to hold tokens until a scaffold fills them in).