This is a Next.js project bootstrapped with create-next-app
.
You will need to set up NodeJS to develop locally after you have cloned this project. There is a .tool-versions
file with the current Node version we are using that can be used with the asdf version manager. You can either asdf install
once you are in the project directory, or manually install the version in that file using your version manager of choice.
Before committing, we have hooks set up that will format/lint/typecheck your code to help prevent having any breaking commits in the history. If you absolutely have to, you can git commit --no-verify
to skip these, but it is recommended as a convention to always run these. To make things performant, linting and formatting only happens on staged files in the pre-commit hook.
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 pages/index.tsx
. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts
.
The pages/api
directory is mapped to /api/*
. Files in this directory are treated as API routes instead of React pages.
This project uses next/font
to automatically optimize and load Inter, a custom Google Font.
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!
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.