Project Template

✨ Features

• 🏎️ Next.js - Fast by default, with config optimized for performance (with App Directory)
• 💅 Tailwind CSS - A utility-first CSS framework for rapid UI development
• ✨ ESlint and Prettier - For clean, consistent, and error-free code
• 🛠️ Extremely strict TypeScript - With ts-reset library for ultimate type safety
• 🚀 GitHub Actions - Pre-configured actions for smooth workflows, including Bundle Size and performance stats
• 💯 Perfect Lighthouse score - Because performance matters
• 📦 Bundle analyzer plugin - Keep an eye on your bundle size
• 🧪 Jest and React Testing Library - For rock-solid unit and integration tests
• 🎭 Playwright - Write end-to-end tests like a pro
• 📚 Storybook - Create, test, and showcase your components
• 🚬 Smoke Testing and Acceptance Tests - For confidence in your deployments
• 📝 Conventional commits git hook - Keep your commit history neat and tidy
• 🔍 Observability - Open Telemetry integration for seamless monitoring
• 📂 Absolute imports - No more spaghetti imports
• ⚕️ Health checks - Kubernetes-compatible for robust deployments
• 🎨 CVA - Create a consistent, reusable, and atomic design system
• 🤖 Renovate BOT - Auto-updating dependencies, so you can focus on coding
• 🩹 Patch-package - Fix external dependencies without losing your mind
• 🤖 Automated ChatGPT Code Reviews - Stay on the cutting edge with AI-powered code reviews!
• 📖 Semantic Release - for automatic changelog
• 🌍 T3 Env - Manage your environment variables with ease
• ✨ More information

📒 Table of Contents

• Project Template
  • ✨ Features
  • 📒 Table of Contents
  • 🎯 Getting Started
  • 🚀 Deployment
  • 📃 Scripts
  • 🧪 Testing
  • 📜 License
  • 🤝 Contribution
  • 💡 Acknowledgements and Inspirations
  • 🫂 Contributors

🎯 Getting Started

To get started with this boilerplate, follow these steps:

1. Fork & clone repository:

## Don't forget to ⭐ star and fork it first :)
git clone https://github.com/tomek-i/Nextjs-Vercel-Template.git

2. Install the dependencies:

yarn install --frozen-lockfile

3. Run the development server:

yarn dev

4. Open http://localhost:3000 with your browser to see the result.

5. This project uses a git hook to enforce conventional commits. To install the git hook, run the following command in the root directory of the project:

brew install pre-commit
pre-commit install -t commit-msg

🚀 Deployment

Easily deploy your Next.js app with Vercel by clicking the button below:

📜 License

This project is licensed under the MIT License. For more information, see the LICENSE file.

🤝 Contribution

We welcome all contributions! To get involved, please follow these steps:

1. Fork this repository.
2. Create a new branch with a clear, descriptive name.
3. Make your changes and commit them using the Conventional Commits format.
4. Push your changes to your forked repository.
5. Submit a pull request, and we will review your contributions.

💡 Acknowledgements and Inspirations

This project template has been inspired and informed by a variety of sources. The following projects have provided valuable insights, configurations, and best practices that have been instrumental in shaping the structure and setup of this template. We extend our gratitude to the creators and contributors of these projects for their pioneering work and for sharing their knowledge with the community.

• Next Enterprise Starter: A comprehensive Next.js project template designed for large-scale enterprise applications. It includes a variety of best practices and advanced configurations. View on GitHub

• VSCode Settings Boilerplate: A meticulously crafted boilerplate for VSCode settings, providing an optimized development environment setup. This resource has been invaluable in configuring our development environment for efficiency and consistency. View on GitHub

We encourage you to explore these projects to gain further insights into their configurations and how they might benefit your own development workflows.

🫂 Contributors

This project is the result of the hard work and dedication of a group of talented individuals who have contributed their time, expertise, and resources to make it a success. Below is a list of contributors and collaborators who have played a significant role in the development, maintenance, and enhancement of this project. We are deeply grateful for their contributions and are proud to showcase their efforts.

Thomas Iwainski

We encourage and welcome contributions from the community. If you would like to contribute to this project, please see our contributing guidelines for more information.