Skip to content

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.

License

Notifications You must be signed in to change notification settings

berlinbruno/nextjs-starter

Repository files navigation

🚀 Next.js Starter

GitHub license npm version GitHub issues GitHub stars

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

📦 Installation

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

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. See the LICENSE file for more details.