@harang-jennie/nextjs-starter/README.md

A Next.js starter kit App Router template with React v18 + Yarn berry + TypeScript + ESLint + Jest + Cypress + Github Actions

<p align="center">
  <a href="https://www.npmjs.com/package/@harang-jennie/nextjs-starter">
    <img src="https://assets.vercel.com/image/upload/v1662130559/nextjs/Icon_light_background.png" height="128">
    <h1 align="center">Next.js Starter</h1>
  </a>
</p>

[![codecov](https://codecov.io/gh/mbti-nf-team/nextjs-starter/branch/main/graph/badge.svg?token=GmcBgBiMo7)](https://codecov.io/gh/mbti-nf-team/nextjs-starter) [![next-starter](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/qh6iij&style=flat-square&logo=cypress)](https://dashboard.cypress.io/projects/qh6iij/runs)   

![yarn](https://img.shields.io/badge/yarn-4.5.3-blue?logo=yarn) ![next.js](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/next?logo=next.js) ![react](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/react?logo=react) ![typescript](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/dev/typescript?logo=typescript) ![jest](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/dev/jest?logo=jest) ![cypress](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/dev/cypress?logo=cypress) ![eslint](https://img.shields.io/github/package-json/dependency-version/mbti-nf-team/nextjs-starter/dev/eslint?logo=eslint) ![eslint](https://img.shields.io/github/repo-size/mbti-nf-team/offbeat-frontend?logo=yarn&style=flat-square)   

A Next.js starter kit app router template with React v19 + Scss + Yarn berry + TypeScript + ESLint + Jest + Cypress + Github Actions

## 🚀 Quick Overview

This project using [Yarn berry](https://yarnpkg.com/features/pnp) (Yarn V.2+) with [zero install](https://yarnpkg.com/features/zero-installs).   
Therefore, `yarn` must be installed before using this next.js starter template.    

```bash
npm install -g yarn
npx @harang-jennie/nextjs-starter <my-nextjs-app>
cd my-nextjs-app
```

> [Why should you upgrade to Yarn Modern?](https://yarnpkg.com/getting-started/qa#why-should-you-upgrade-to-yarn-modern)

## 💻 eslint extends
- [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
- [eslint-config-airbnb-typescript](https://www.npmjs.com/package/eslint-config-airbnb-typescript)
- [eslint-import-resolver-alias](https://www.npmjs.com/package/eslint-import-resolver-alias)
- [eslint-import-resolver-typescript](https://www.npmjs.com/package/eslint-import-resolver-typescript)
- [eslint-plugin-cypress](https://www.npmjs.com/package/eslint-plugin-cypress)
- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
- [eslint-plugin-jest](https://www.npmjs.com/package/eslint-plugin-jest)
- [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)
- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)
- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)
- [eslint-plugin-testing-library](https://www.npmjs.com/package/eslint-plugin-testing-library)
- [eslint-plugin-unused-imports](https://www.npmjs.com/package/eslint-plugin-unused-imports)
- [eslint-plugin-simple-import-sort](https://www.npmjs.com/package/eslint-plugin-simple-import-sort)

## 🔒 LICENSE
This Project is [MIT licensed](https://github.com/jennie-harang/nextjs-starter/blob/main/LICENSE).