https://github.com/tynandebold/nextjs-starter-template

A starter project for Next.js with TypeScript, Storybook, Jest, ESLint, and more.
https://github.com/tynandebold/nextjs-starter-template

boilerplate demo javascript jest nextjs nodejs react ssr starter-kit storybook

Last synced: 21 days ago
JSON representation

A starter project for Next.js with TypeScript, Storybook, Jest, ESLint, and more.

• Host: GitHub
• URL: https://github.com/tynandebold/nextjs-starter-template
• Owner: tynandebold
• Created: 2020-12-18T14:33:03.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-18T14:37:01.000Z (about 4 years ago)
• Last Synced: 2024-12-06T20:50:32.431Z (2 months ago)
• Topics: boilerplate, demo, javascript, jest, nextjs, nodejs, react, ssr, starter-kit, storybook
• Language: TypeScript
• Homepage:
• Size: 195 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Next.js Starter Template

A developer-friendly Next.js app configured with:

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

- Linting: [ESLint](https://eslint.org/)

- Formatting: [Prettier](https://prettier.io/)

- Linting, typechecking and formatting on commit using [`husky`](https://github.com/typicode/husky)

- Testing: [Jest](https://jestjs.io/) and [`react-testing-library`](https://testing-library.com/docs/react-testing-library/intro)

- [Storybook](https://storybook.js.org/docs/react/get-started/introduction)

## Scripts

| Command                   | Description                                                       |

| ------------------------- | ----------------------------------------------------------------- |

| `npm run build`           | Create an optimized production build                              |

| `npm run dev`             | Start a new local development server on [http://localhost:3000]() |

| `npm run storybook`       | Start a new Storybook server on [http://localhost:7070]()         |

| `npm run storybook:build` | Build Storybook to static HTML                                    |

| `npm run test`            | Run tests using Jest                                              |

| `npm run test:update`     | Run tests and update snapshots, if necessary, using Jest          |

| `npm run test:watch`      | Run tests in watch mode using Jest                                |

| `npm run test-all`        | Run lint, type check, and tests using Jest                        |

## Storybook

### Run it

```bash

npm run storybook

```

### Build it

```bash

npm run build-storybook

```

If desired, Storybook can be [built and published](https://storybook.js.org/docs/react/workflows/publish-storybook) as a static web application