Skip to content

teyim/nextjs-typescript-boilerplate

Repository files navigation

Nextjs Typescript boilerplate

A Next-Typescript boilerplate to quickly and easily bootstrap your next project. Comes pre-configured with, Tailwindcss, Eslint, Prettier, Lint-staged ,Husky and Commitizen. 🚀

Features

  • ⚡ Nextjs for SSR and SSG

  • 👀 Typescript for type checking

  • 💅 Tailwind css for styles

  • 📏 Eslint for code quality control

  • 💇 Prettier for code formatting

  • 🐺 Husky for Git Hooks

  • ⛔Lint-staged for running lint on staged files

  • ❗ Commitizen for setting conventional commit message standards for commit messages

Getting started

Using this boilerplate is quite easy. first clone the repo

git clone https://github.com/teyim/minimal-nextjs-typescript-boilerplate.git

now, install the projects dependencies via yarn:

yarn install

and then spin-up your nextjs dev server:

  npm run dev

Working with Commitizen

After staging the files you wish to commit, type:

cz

command ,which will bring up a commitizen commandline interface with conventional commit options to commit your code.

Customisation

  1. Project name

Customise the project name by navigating to the package.json file and changing the name property.


  • Don't forget to give this project a star ⭐

  • Follow me on Twitter

About

A Nextjs-Typescript boilerplate , configured with Tailwindcss, Eslint, Prettier, Lint-staged ,Husky and commitizen

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published