Skip to content
/ next-template Public template

Boilerplate of Next.js project with Lint, TypeScript, Sass (SCSS), Tailwind, Framer Motion, React Hook Form, Zod, SWR, Vitest, Storybook, CI/CD, Git Hooks (Lefthook) and more.

Notifications You must be signed in to change notification settings

wiyco/next-template

Repository files navigation

next-template

Next.js framework starter repository 🐢

Tech Stack

Environments Languages Linters Frameworks Libraries Testing CI/CD
node-logo
npm-logo
ts-logo
sass-logo
eslint-logo
stylelint-logo
prettier-logo
lefthook-logo
next-logo react-logo
tailwind-logo
swr-logo
zod-logo
rhf-logo
vitest-logo
storybook-logo
githubactions-logo

Other

Development

  1. Required
  2. Environment Variables
  3. Commands

Required

node = ">=20.18"
npm = ">=10.9"

Tip

See .prototools for more details.

Environment Variables

Tip

See .env.example for more details.

Commands

Installing Packages

npm i

Important

After the initial installation (if the format-on-save feature is not working), restart VS Code (IDE).

Note

In the future, I want to migrate the Linter and Formatter from ESLint and Prettier configurations to Biome. However, I need to check compatibility by comparing the configuration options.

Start Development Server

npm run dev

Linting

npm run lint

Formatting Code

npm run format

Running Storybook (UI component tests)

npm run sb

Running Tests

npm run test

Tip

See scripts in package.json for more details.

About

Boilerplate of Next.js project with Lint, TypeScript, Sass (SCSS), Tailwind, Framer Motion, React Hook Form, Zod, SWR, Vitest, Storybook, CI/CD, Git Hooks (Lefthook) and more.

Resources

Stars

Watchers

Forks