https://github.com/susomejias/nextjs-skeleton

Skeleton repository with all the necessary configurations to start a project with NextJS
https://github.com/susomejias/nextjs-skeleton

cypress editorconfig eslint jest nextjs prettier sass stylelint testing-library typescript

Last synced: 18 days ago
JSON representation

Skeleton repository with all the necessary configurations to start a project with NextJS

• Host: GitHub
• URL: https://github.com/susomejias/nextjs-skeleton
• Owner: susomejias
• Created: 2021-10-17T12:25:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T04:58:47.000Z (almost 3 years ago)
• Last Synced: 2025-10-11T20:07:00.214Z (9 months ago)
• Topics: cypress, editorconfig, eslint, jest, nextjs, prettier, sass, stylelint, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 547 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![NextJS logo](https://upload.wikimedia.org/wikipedia/commons/thumb/8/8e/Nextjs-logo.svg/440px-Nextjs-logo.svg.png)

![example workflow](https://github.com/susomejias/nextjs-skeleton/actions/workflows/ci.yml/badge.svg)

## 🔧 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``