Skip to content

susomejias/nextjs-skeleton

Repository files navigation

NextJS logo

example workflow

🔧 Configurations included

🎨 Styles

  • Sass modules
  • Added mixin with default breakpoints

💅 Code Style

  • ESLint
  • Stylelint
  • Prettier
  • Editor config

✅ Testing

  • Cypress
  • Jest
  • Testing library

🔃 GitHub workflows

  • Build/Lint
  • Unit tests
  • E2E tests
  • Code quality

❓ How to use

Setup

  1. Use this repository as a template
  2. Clone the new repository
  3. Install dependencies: yarn install

Server/Development

  1. Run server: yarn dev

Server/Production

  1. Generate build: yarn build
  2. Run server: yarn start

Run tests

  1. Unit tests: yarn jest
  2. E2E tests (the local server should is running): yarn cy:run

Run linters

  1. ESLint: yarn eslint
  2. Stylelint: yarn stylelint
  3. Both: yarn lint