https://github.com/santospatrick/nextjs-boilerplate

Next.js boilerplate with Typescript/Styled Components/Jest/Git Hooks
https://github.com/santospatrick/nextjs-boilerplate

boilerplate git-hooks hooks jest styled-components typescript

Last synced: 19 days ago
JSON representation

Next.js boilerplate with Typescript/Styled Components/Jest/Git Hooks

• Host: GitHub
• URL: https://github.com/santospatrick/nextjs-boilerplate
• Owner: santospatrick
• Created: 2021-03-07T21:35:19.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-03T19:24:05.000Z (over 3 years ago)
• Last Synced: 2024-10-12T05:45:48.725Z (about 1 month ago)
• Topics: boilerplate, git-hooks, hooks, jest, styled-components, typescript
• Language: TypeScript
• Homepage:
• Size: 2.5 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `@santospatrick/nextjs-boilerplate`

## Usage

```bash

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

```

## Features

- [x] [Next.js](https://nextjs.org/)

- [x] [Typescript](https://www.typescriptlang.org/)

- [x] [Styled Components](https://styled-components.com/)

- [x] [Next.js PWA](https://www.npmjs.com/package/next-pwa)

- [x] [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/)

- [x] [Jest](https://jestjs.io/)

- [x] [ESLint](https://github.com/santospatrick/eslint-config-react)/[Prettier](https://github.com/santospatrick/prettier-config)

- [x] [Husky (Git Hooks)](https://github.com/typicode/husky)/[Lint Staged](https://github.com/okonet/lint-staged)

- [x] [Storybook](https://storybook.js.org/)

- [x] [Plop (Template Generator)](https://plopjs.com/)

- [ ] [Stylelint](https://stylelint.io/)

- [ ] [SWR](https://swr.vercel.app/)

## 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](https://github.com/santospatrick/eslint-config-react)/[Prettier](https://github.com/santospatrick/prettier-config) for all files inside `src/`

#### `yarn test`

Runs [Jest](https://jestjs.io/) 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](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest))

#### `yarn storybook`

Runs [Storybook](https://storybook.js.org/) server locally at `http://localhost:6006`

#### `yarn build-storybook`

Builds [Storybook](https://storybook.js.org/) static files to `storybook-static` folder