@davidyang2149/nextjs-starter

Next.js starter with TypeScript, Jest, Testing-Library, Cypress


Keywords
Next.js, nextjs, Next.js starter, nextjs starter, starter, typescript, eslint, jest, testing-library, cypress, hacktoberfest, react, starter-kit
License
MIT
Install
npm install @davidyang2149/nextjs-starter@3.0.6

Documentation

Next.js starter

๐Ÿš€ Quick start

npx @davidyang2149/nextjs-starter <project-directory>

๐Ÿ’Ž Tech stack

  • TypeScript
  • Next.js
  • React
  • Jest
  • Testing Library
  • Cypress
  • ESLint

๐Ÿ”– Node Version in project

# .nvmrc
v18.14.0

If you want to manage nvm. recommend to use fnm(Fast Node Manager)

# use Homebrew
brew install fnm

๐Ÿ“š Recommend package manager

# use Homebrew
brew install pnpm

๐Ÿ“š Install dependencies

pnpm install

๐Ÿ’ป Run dev server

pnpm run dev

๐Ÿงช Lint and fix

pnpm run lint

๐Ÿงช Run Coverage

pnpm run test:unit

# running option
pnpm run test

๐Ÿงช Run E2E tests

pnpm run e2e

# headless option
pnpm run e2e:headless

Use E2E test report

When open Pull Request, you can use an e2e testing report by GitHub Actions. Set GitHub Pages in your repository.

๐Ÿค Special thanks to

JetBrains Logo

โœ๏ธ Authors

See also the list of contributors who participated in this project.

๐Ÿ“ License

MIT License

Copyright (c) 2021 David Yang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.