Supported tooling
- Node.js 18+
- pnpm 8+
- TypeScript 5
- Next.js App Router
Project scripts
All commands run from the repository root:pnpm test if you add automated tests. The scaffold is ready for Vitest or Jest but no suites ship by default.
Recommended workflow
- Create a feature branch:
git checkout -b feature/<topic> - Run
pnpm devand iterate with hot reload. - Keep commits focused on a single feature or fix. Include screenshots or Loom links when editing UI.
- Run
pnpm lintandpnpm buildbefore pushing to catch TypeScript or layout issues early. - Open a pull request against
mainand request review from the Lab68 maintainers.
Working with translations
Localization data lives inlib/i18n.ts and supports nine locales by default.
- Add new keys to the English dictionary first, then extend locale overrides.
- Run the helper scripts in
scripts/when performing large copy updates:
- Scripts ensure fallbacks remain intact and encoding issues are fixed automatically.
Theming and design system
The global layout and theme provider are defined inapp/layout.tsx.
- Toggle between dark and light mode using the built-in theme context.
- Reuse primitives from
components/(e.g.,Sidebar,PageHeader,MetricCard) instead of rebuilding layout widgets. - Global Tailwind tokens live in
styles/.
Debugging tips
- Use
pnpm dev --turbofor faster refresh when sweeping many files. - Append
NEXT_DEBUG=truein.env.localto surface additional logging from Next.js and API routes. - Inspect server logs directly in the terminal running
pnpm dev; API route errors include stack traces and context payloads.
Deployment flow
The repository is configured for Vercel. A typical promotion pipeline looks like this:- Configure environment variables for preview and production in the Vercel dashboard.
- Monitor build logs for ESLint or type errors; the same checks run locally when you execute
pnpm build.
