Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidyang2149/nextjs-starter

Nextjs Starter Kit
https://github.com/davidyang2149/nextjs-starter

cypress hacktoberfest jest nextjs react starter-kit typescript

Last synced: about 1 month ago
JSON representation

Nextjs Starter Kit

Awesome Lists containing this project

README

        

# Next.js starter
- GitHub: [Next.js starter kit](https://github.com/DavidYang2149/nextjs-starter)
- npm: [Download](https://www.npmjs.com/package/@davidyang2149/nextjs-starter)

## ๐Ÿš€ Quick start

```sh
npx @davidyang2149/nextjs-starter
```

## ๐Ÿ’Ž Tech stack
- TypeScript
- Next.js
- React
- Zustand
- ESLint
- Vitest
- Testing Library
- Playwright

## ๐Ÿ”– Node Version in project

```sh
# .nvmrc
v20.14.0
```
If you want to manage nvm. recommend to use [fnm(Fast Node Manager)](https://github.com/Schniz/fnm)

```sh
# use Homebrew
brew install fnm
```

## ๐Ÿ“š Recommend package manager

```sh
# use Homebrew
brew install pnpm
```

## ๐Ÿ“š Install dependencies

```sh
pnpm install
```

## ๐Ÿ’ป Run dev server

```sh
pnpm dev
# or
pnpm run dev
```

## ๐Ÿงช Lint and fix

```sh
pnpm lint
# or
pnpm run lint
```

## ๐Ÿงช Run Coverage

```sh
pnpm test:unit
# or
pnpm run test:unit

# running option
pnpm run test
```

## ๐Ÿงช Run E2E tests

```sh
pnpm test:e2e
# or
pnpm run test:e2e
```

## ๐Ÿค Special thanks to

JetBrains Logo

## โœ๏ธ Authors
- [Davidyang2149](https://github.com/DavidYang2149) - **David Yang** -

See also the list of [contributors](https://github.com/DavidYang2149/nextjs-starter/graphs/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.

```