The objective of this boilerplate is to set up everything the developer will need (in terms of configuration) to start a next + typescript project. Eslint, prettier and husky are configured to work independent of the user's IDE configuration (as long as it's vscode).
- Typescript
- NextJS
- It comes with Inter (it's better to host fonts here rather than getting them from google fonts).
- Pages, components, etc... are located under
/src
. If you are changing this, be sure to also updatetsconfig.json
'sbaseUrl
.
-
Install yarn:
npm install -g yarn
-
Install the dependencies with:
yarn
-
Start developing and watch for code changes:
yarn dev
-
Add project specific data to
src/lib/constants
If you find you need to make extra config to make this work more seamlessly, feel free to submit a PR suggesting your changes. Our focus is to get you up and running with the least steps and burden as possible.