mikestecker / next-boilerplate

Next Boilerplate

My very own NextJS boilerplate created for use in projects.

Features (so far)

• ⚡️ Next 13
• 🦾 TypeScript, of course
• 🫀 Jest - unitary testing made easy
• 🎨 Tailwind with JIT - next generation utility-first CSS
• 🌚 Dark Mode
• 👩‍🎤 Emotion
• 🪢 CSS Modules
• 👑 Atomic Design organization
• 🗂 Absolute imports
• 😃 Hero icons
• 🗺️ Next Sitemap
• ☁️ Deploy on Vercel, zero-config

Coding Style

• ESLint
• Prettier

Dev tools

• TypeScript
• Vercel - zero-config deployment

Try it now!

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

npx degit mikestecker/next-boilerplate my-nextjs-app
cd my-nextjs-app
yarn # If you don't have yarn installed, run: npm install -g yarn

Checklist

When you use this template, try follow the checklist to update your info properly

• Rename name and author fields in package.json
• Change the author name in LICENSE
• Change the title in index.html
• Change the favicon in public
• Modify the manifest in public
• Clean up the README's

And, enjoy :)

Usage

Development

Type:

yarn dev

Then visit http://localhost:3000

Build

To build like if it was for production run

yarn build
yarn start

Then you can visit http://localhost:3000 and check that everything works as expected.

Deploy on Vercel

Go to Vercel and select your repository, OK along the way, and your App will be live in a minute.

Issues

Dark mode

With CSS-Modules the "global" css-var .dark is not visible inside .module.css files, thus the Tailwind variant dark:x does not work.

In order for it to work inside module.css files you must leverage to :global, example:

:global(.dark) .title {
  @apply text-white;
}

Husky

If pre-commit hooks are not working be sure that you have installed husky: husky install.

By default this command should be triggered after yarn/npm deps are installed.