https://github.com/samuel-gomez/starter-nextjs

Starter NextJS
https://github.com/samuel-gomez/starter-nextjs

codecov commitizen commitlint cypress eslint github-actions husky jest msw nextjs prettier react renovate sass sonar sonarcloud testing-library typescript vscode

Last synced: about 1 month ago
JSON representation

Starter NextJS

• Host: GitHub
• URL: https://github.com/samuel-gomez/starter-nextjs
• Owner: samuel-gomez
• License: mit
• Created: 2021-12-21T14:31:57.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T22:30:06.000Z (2 months ago)
• Last Synced: 2024-10-29T22:52:42.664Z (2 months ago)
• Topics: codecov, commitizen, commitlint, cypress, eslint, github-actions, husky, jest, msw, nextjs, prettier, react, renovate, sass, sonar, sonarcloud, testing-library, typescript, vscode
• Language: JavaScript
• Homepage: https://starter-nextjs.samuelgomez.fr/
• Size: 1.56 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![GitHub issues](https://img.shields.io/github/issues/samuel-gomez/starter-nextjs)](https://github.com/samuel-gomez/starter-nextjs/issues)

[![GitHub license](https://img.shields.io/github/license/samuel-gomez/starter-nextjs)](https://github.com/samuel-gomez/starter-nextjs/blob/main/LICENSE)

[![Build](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/build.yml/badge.svg)](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/samuel-gomez/starter-nextjs/branch/main/graph/badge.svg)](https://codecov.io/gh/samuel-gomez/starter-nextjs)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![CodeQL](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/codeql-analysis.yml)

[![Cypress](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/cypress.yml/badge.svg)](https://github.com/samuel-gomez/starter-nextjs/actions/workflows/cypress.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=samuel-gomez_starter-nextjs&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=samuel-gomez_starter-nextjs)

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Demo

https://starter-nextjs.samuelgomez.fr/

## Getting Started

First, run the development server:

```bash

npm run dev

# or

yarn dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.

- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Customization

This stack has been completed and customized with some features ([more details](./docs/CUSTOMIZATION.md))