Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.4 KB

README.md

File metadata and controls

52 lines (32 loc) · 2.4 KB
Raw

next-typescript

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

Deploy with Vercel

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 tsconfig.json's baseUrl.

Development

  1. Install yarn:

    npm install -g yarn

  2. Install the dependencies with:

    yarn

  3. Start developing and watch for code changes:

    yarn dev

Important Things to Do

  • Check out .env.example for required environment variables to run the project.
  • Add favicons. (Re)Place in ./public: 32x32 favicon.ico, perfect square favicon.svg and favicon-dark.svg (dark theme), 512x512 icon-512.png, 192x192 icon-192.png, 180x180 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).
  • Delete console.log(basementLog) if not wanted — it's under _app.tsx.
  • Replace the contents of this file (README.md) with the contents of the README.example.md file — make sure to adapt it to your project's specific needs. Finally, delete the old README.example.md file.

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.

cover image