This is a Next.js template bootstrapped with create-next-app with the following options:
--typescript
--eslint
--src-dir
--appSome plugins were added to force a consistent and strict code style.
Prettier is used for formatting.
The following plugins and rulesets for eslint:
- unicorn/recommended
- eslint:recommended
- promise/recommended
- security/recommended
- eslint-comments/recommended
- typescript-eslint/recommended-requiring-type-checking
- typescript-eslint/strict
- plugin:functional/external-typescript-recommended
- plugin:functional/stylistic
- plugin:functional/no-exceptions
- react/recommended
- confusingBrowserGlobals
The following compiler options for typescript were added:
noUnusedLocals
noUnusedParameters
noFallthroughCasesInSwitch
noUncheckedIndexedAccessAdditionally, a few custom rules were added to fit my code style and prevent conflicts.
You can use Lefthook to run all checks as a pre-commit hook.
Just run lefthook install and you are good to go.
Some additional scripts were added to make things a bit easier:
yarn formatCheck checks the formatting of your files.
yarn formatFix fixes the formatting of your files.
yarn export runs the static html export for nextjs.
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm devOpen 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.