/nextjs-typescript-tailwind-template

A default Next.js project with boilerplate packages and configurations. Includes Tailwind, TypeScript (strict), ESLint, Prettier, and Husky.

Primary LanguageTypeScript

Yet another Next.js project template

This template includes a set of our favorite dev tools scaffolded into a Next.js project. Tools include:

  • TypeScript
  • Tailwind CSS
  • ESLint, with Prettier plugin
  • Prettier, include Tailwind Plugin
  • Husky pre-commit hooks for formatting
  • Jest
  • Docker

The easiest way to get started with this template is with degit to avoid including the template commit log:

npm install -g degit # or yarn add --global degit

Once installed:

degit JoeyMckenzie/nextjs-typescript-tailwind-template your-project-name
cd your-project-name && npm install

If you'd prefer to simply git clone instead:

git clone https://github.com/JoeyMckenzie/nextjs-typescript-tailwind-template.git your-project-name
cd your-project-name && git remote remove origin

To start with Docker, verify you have it installed, then:

docker-compose up --build

Note on Docker usage:

The Docker image is the officially recommended build configuration preconfigured with npm. If you prefer to use yarn, do the following within Dockerfile:

# If using yarn with a `yarn.lock` comment out below
# COPY package.json yarn.lock ./
# RUN yarn install --frozen-lockfile

# If using npm with a `package-lock.json` comment out above and use below instead
COPY package.json package-lock.json ./
RUN npm ci