@santospatrick/nextjs-boilerplate

Usage

yarn create next-app -e https://github.com/santospatrick/nextjs-boilerplate

Features

• Next.js
• Typescript
• Styled Components
• Next.js PWA
• React Testing Library
• Jest
• ESLint/Prettier
• Husky (Git Hooks)/Lint Staged
• Storybook
• Plop (Template Generator)
• Stylelint
• SWR

Scripts

yarn dev

Runs development environment locally at http://localhost:3000

yarn build

Builds project to .next folder

yarn start

Runs production environment (make sure to run yarn build first)

yarn lint

Runs ESLint/Prettier for all files inside src/

yarn test

Runs Jest tests for all ts/tsx files inside src

yarn test:watch

Runs and keep watching Jest tests for all ts/tsx files inside src (You don't need this if you have Jest extension installed in VSCode)

yarn storybook

Runs Storybook server locally at http://localhost:6006

yarn build-storybook

Builds Storybook static files to storybook-static folder