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).
Featured Aspects of the Stack
Things to Note
- 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 update
npm install -g yarn
Install the dependencies with:
Start developing and watch for code changes:
Important Things to Do
- Check out
.env.examplefor required environment variables to run the project.
- Add favicons. (Re)Place in
favicon.ico, perfect square
favicon-dark.svg(dark theme), 512x512
apple-touch-icon.png. You can use something like this for some (better to use Gimp, Photoshop, or any graphics editor; read more about it here).
console.log(basementLog)if not wanted — it's under
- Replace the contents of this file (
README.md) with the contents of the
README.example.mdfile — make sure to adapt it to your project's specific needs. Finally, delete the old
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.