README.md

Next.js Template

This is based on the with-typescript-eslint-jest Next.js example project.

Bootstrap a developer-friendly NextJS app configured with:

• Typescript
• Linting with ESLint
• Formatting with Prettier
• Linting, typechecking and formatting on by default using husky for commit hooks
• Testing with Jest and react-testing-library

It also includes my base-scripts to make it easy to get started with this project without having to know any of the underlying tools or how to use them.

How to use

There is no special one-off setup required for this project to you can simply run the server bash or PowerShell script:

$ ./script/server

or

> .\script\server.ps1

You should now be running in development mode on http://localhost:3000.

This runs next dev to get start in development mode rather than next start which start a production server. Note that next is installed as a node package locally so the next command isn't necessarily available directly from the command line so it is actually called using npm run dev.