https://github.com/berlinbruno/nextjs-starter

Next.js Starter: A template for building web apps with React, TypeScript, and PWA support. Includes Tailwind CSS, Husky, Prettier, ESLint, Commentlint, CI support, customizable themes, and built-in SEO features.
https://github.com/berlinbruno/nextjs-starter

commentlint continuous-integrations husky next next-themes nextjs-starter prettier-eslint prettier-plugin-tailwindcss progressive-web-app react tailwindcss typescript

Last synced: about 1 month ago
JSON representation

Next.js Starter: A template for building web apps with React, TypeScript, and PWA support. Includes Tailwind CSS, Husky, Prettier, ESLint, Commentlint, CI support, customizable themes, and built-in SEO features.

• Host: GitHub
• URL: https://github.com/berlinbruno/nextjs-starter
• Owner: berlinbruno
• License: mit
• Created: 2024-10-13T17:54:55.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-11-16T15:53:21.000Z (about 2 months ago)
• Last Synced: 2024-11-16T16:32:47.157Z (about 2 months ago)
• Topics: commentlint, continuous-integrations, husky, next, next-themes, nextjs-starter, prettier-eslint, prettier-plugin-tailwindcss, progressive-web-app, react, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://nextjs-starter.berlinbruno.dev
• Size: 1.5 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# 🚀 Next.js Starter

[![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)

[![npm version](https://img.shields.io/npm/v/@berlinbruno/nextjs-starter.svg)](https://www.npmjs.com/package/@berlinbruno/nextjs-starter)

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

[![GitHub stars](https://img.shields.io/github/stars/berlinbruno/nextjs-starter.svg)](https://github.com/berlinbruno/nextjs-starter/stargazers)

A powerful starter template for building modern web applications using **Next.js**, **React**, and **TypeScript**. This template incorporates essential features for efficient development and optimal performance.

## 🌟 Features

- **Next.js**: 🌐 Server-side rendering and static site generation capabilities.

- **React**: ⚛️ Build interactive user interfaces with a component-based approach.

- **TypeScript**: 🛡️ Strongly typed language for improved developer experience.

- **Progressive Web App (PWA)**: ⚡ Enhanced performance and offline capabilities.

- **Tailwind CSS**: 🎨 Utility-first CSS framework for rapid UI development.

- **Husky**: 🐶 Git hooks for enforcing quality checks before commits.

- **Prettier & ESLint**: ✨ Automated code formatting and linting for consistent code quality.

- **Commentlint**: 💬 Maintain consistent comment styles throughout your codebase.

- **Continuous Integration**: 🔄 Seamless integration with CI/CD workflows.

- **Next Themes**: 🎭 Easy theming for customizable user experiences.

- **SEO Features**: 📈 Built-in support for optimizing web visibility.

## 🌐 Live Demo

Check out the live demo of this starter template: [Live Demo](https://www.nextjs-starter.berlinbruno.dev)

## 📦 Installation

To create a new Next.js app using this starter template, run the following command:

```bash

npx @berlinbruno/nextjs-starter my-app

```

## ⚙️ Usage 

Customize the template according to your project requirements. Key areas to modify include:

- **`package.json`**: Update the `author`, `description`, and `name`.

- **`constants/data.ts`**: Change any static data or constants.

- **SEO Setup**: Use the `generateSiteMetadata` function from `seo.ts` to manage SEO metadata.

- **Images and Favicon**: Replace the favicon and images in the `public` folder.

## 🤝 Contributing

Contributions are welcome! Feel free to submit issues or pull requests to help improve the template.

## 📄 License

This project is licensed under the [MIT License](LICENSE). See the LICENSE file for more details.