This is a Next.js project bootstrapped with create-next-app
.
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx
. The page auto-updates as you edit the file.
This project uses next/font
to automatically optimize and load Geist, a new font family for Vercel.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
This repo is structured to be reused:
- Opinionated tooling: ESLint (flat), Prettier (with Tailwind plugin), Husky + lint-staged, Commitlint
- Testing: Vitest + React Testing Library + jsdom
- Env validation with
zod
insrc/env.ts
(copy.env.example
to.env.local
) - CI: GitHub Actions workflow (
.github/workflows/ci.yml
)
Common scripts:
npm run dev
– start dev servernpm run lint
– ESLint checknpm run format
/format:check
– Prettiernpm run test
/test:ci
– run tests (with coverage in CI)npm run typecheck
– TypeScript project checknpm run build
– production build
To use as a new project:
- Create a new repo from this template (or
degit
it) - Update
package.json
name,README
, and licensing - Fill
.env.local
using.env.example
- Push to your org and open a PR to verify CI passes
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.