next-app-general-boilerplate

A boilerplate wrapping create-next-app with general FE environment setup.

This boilerplate provides integrated setup for...

• Prettier
• ESlint
• husky
• lint-staged
• Storybook
• Jest
• Cypress

CSS Variations

Want to use SCSS for styling? Refer to the main branch. It also contains stylelint for linting(allow kebap-case & BEM), and clsx & cva utilities for component styling.

Want to use Vanilla-extract for styling? Refer to the vanilla-extract branch.

Getting Started

1. Clone this repository:

git clone --depth=1 git@github.com:J3m3/next-app-general-boilerplate.git your-project-name
cd your-project-name

2. Install all dependencies:

pnpm install

3. Run the local development server:

pnpm dev

Note

This boilerplate uses pnpm as a package manager. Here's some "npx" equivalents for pnpm.

# Running executables inside your downloaded dependencies
npx eslint --fix file.ts
pnpm exec eslint --fix file.ts

# Running executable commands in packages you want to download transiently
npx storybook@latest init
pnpm dlx storybook@latest init

Reference

https://stackoverflow.com/questions/75413361/can-i-use-npx-with-pnpm