NextJS Starter Kit

This setting used by This Repository

Default Settings

• Yarn2 with PnP
• NextJS with TypeScript
• Enable MDX
• Storybook on Webpack5 with Sass (Using @storybook/preset-scss)
  • If you load in /public directory's image, for example:
    • If You want /public/logo.png
    • Then you use /logo.png
    • example: <Image src="/logo.png" alt="alt" width={30} height={30} />
• Jest (coverage 100%)
• Cypress
• ESLint with airbnb-typescript rules
• Github Actions (Coverage, E2E, Deploy gh-pages and storybook)
• Using Husky
  • Auto update patch version before commit
  • Check Lint, Coverage, E2E before push

[ IMPORTANT ] Must Change Here

• package.json line 2 - project name
• next.config.js line 4, 5 - production url and path
• /public/favicon.ico and /public/icon-*.png
• /public/manifest.json line 5~9 - application information
• /pages/_document.tsx line 10 - lang
• /pages/_app.tsx line 17, 20 - description, title

Usage

Install

yarn && yarn postinstall

Running Dev Server

yarn dev

Lint

yarn lint

Unit Test

yarn test
yarn test:watch
yarn test:coverage

E2E Test

yarn cypress
yarn cypress:headless
yarn e2e
yarn e2e:headless

Storybook

yarn storybook
yarn build-storybook

Build and Export

yarn build
yarn start
yarn export