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: 4 months ago
JSON representation
Nextjs starter template to quickly fire up new projects
- Host: GitHub
- URL: https://github.com/tomek-i/nextjs-project-template
- Owner: tomek-i
- Created: 2024-08-26T10:17:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-25T10:17:50.000Z (4 months ago)
- Last Synced: 2025-02-25T11:23:19.898Z (4 months ago)
- Topics: nextsjs, starter-template, template, template-project, typescript
- Language: TypeScript
- Homepage:
- Size: 1.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
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.