README.md

NextJS TypeScript Boilerplate

Quickly start your next NextJS projects with TypeScript, TailwindCSS out of the box.

1. Prerequisites

• Node >= 8.10.0
• Yarn >= 1.5.0

2. Installation

• Clone repository:

git clone git@github.com:nhanhoangtrong/nextjs-ts-boilerplate.git

• Change to working directory
• Run package install command:

yarn

• Start development server with:

yarn dev

3. Scripts

3.1. Build production bundle

yarn build

3.2. Start production server

yarn start

3.3. Analyze production bundle

yarn analyze

3.4. Run tests with Jest

# Run tests
yarn test

# Run test and view coverage
yarn coverage

3.5. Other utils

# Run eslint error checking
yarn lint

# Run prettier formating
yarn prettier

4. License

MIT License

Copyright (c) 2020 Kendy Hoang