An open API service indexing awesome lists of open source software.

https://github.com/tomek-i/nextjs-project-template

Nextjs starter template to quickly fire up new projects
https://github.com/tomek-i/nextjs-project-template

nextsjs starter-template template template-project typescript

Last synced: 3 months ago
JSON representation

Nextjs starter template to quickly fire up new projects

Awesome Lists containing this project

README

        

# Nextjs Starter Template

This is a [Next.js](https://nextjs.org/) starter template.

## Table of Contents

- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Features](#features)
- [Learn More](#learn-more)

## Introduction

This project serves as a starter template for building modern web applications using Next.js. It includes a set of tools and libraries to help you get started quickly and efficiently.

## Prerequisites

Before you begin, ensure you have the following installed:

- Node.js (>= 20.x)
- npm, yarn (package managers)

## 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 `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Features

Explore the unique features of this starter template:

- ๐Ÿš€ **Next.js**: [nextjs.org](https://nextjs.org/)
- ๐Ÿ“š **Storybook**: [storybook.js](https://storybook.js.org/)
- ๐ŸŽจ **Tailwind CSS**: [tailwindcss](https://tailwindcss.com/)
- ๐Ÿ› ๏ธ **Class Variants Authority**: [cva.style](https://cva.style/docs/getting-started/installation)
- ๐Ÿ”„ **twmerge**: [tailwind-merge](https://github.com/dcastil/tailwind-merge)
- ๐Ÿ›ก๏ธ **Zod**: [zod.dev](https://zod.dev/)
- ๐Ÿ—„๏ธ **Prisma**: [prisma.io](https://www.prisma.io/)
- ๐Ÿ”ง **Plop**: [plopjs.com](https://plopjs.com/)
- ๐Ÿ›ก๏ธ **Sentry**: [sentry.io](https://sentry.io)
- ๐Ÿถ **Husky**: [husky](https://typicode.github.io/husky/)
- ๐Ÿ’„ automatically add emojis to commit messages
- ๐Ÿงช run tests pre-commit
- ๐Ÿค– **GitHub Workflows**:
- โœ… Convert TODO's to issues
- ๐Ÿ“Š Jest coverage reports // TODO: enable coverage reports
- ๐Ÿงช Run tests
- TODO: add stryker mutation testing
- TODO: add e2e testing using plyweight or puppeteer or cypress
- ๐Ÿ“ **Issue & Pull Request Templates**
- ๐Ÿ› ๏ธ **Recommended Extensions**
- โš™๏ธ **Custom VSCode Settings**

## 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.