Next.js Monorepo Boilerplate

Welcome to the Next.js Monorepo Boilerplate(NextJs 15, ReactJs 19)! This boilerplate provides a solid foundation for managing complex web applications with multiple applications and shared packages in a single, efficient monorepo. It contains a basic auth based on Next-auth.

🚀 What's inside?

• app: Next.js app with Tailwind CSS
• @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• @repo/typescript-config: tsconfig.jsons used throughout the monorepo
• @repo/ui: a stub React component library with Tailwind CSS and shadcn/ui

Additional tools already setup:

• Tailwind CSS for styles
• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

🤖 Installation

To get started, clone the repository. Make sure you have Node.js, pnpm and Docker installed.

🤸 Quick Start

This project is Docker-ready, supporting both development and production environments. But you don't have to use it, if you prefer using local tools like Node.js, pnpm, etc., feel free to do so! Just check package.json for available scripts.

Development

Copy [.env.example] and rename it to .env then add your environment variables.

1. Build the image.

   pnpm install
   docker-compose --profile dev build

2. Run the container and initialize prisma

   docker-compose --profile dev up -d && pnpm run prisma:init:development

You can then access your applications on http://localhost:3000.

To build production image, just set prod in --profile flag and in .env change the value of NODE_ENV to production

Makefile

Usage

You can simply run make in your terminal. For example, to build your project, you would run:

make dev-build

make dev-init

For more information on each command, you can refer to the comments in the Makefile

🔋 Release Process and Changelog

We use Semantic Versioning for version numbers. All notable changes to this project are automatically documented in the release notes.

Automated Changelog

Our project uses release-drafter to automatically generate changelogs based on PR titles and labels. When creating a pull request, please ensure that the title clearly describes the change and that appropriate labels are applied. This will help in generating accurate and informative release notes.

Creating a Release

1. Ensure all changes for the release are merged into the main branch.

2. Create a new tag with the version number:

   git tag vX.Y.Z
   git push origin vX.Y.Z
   

3. The GitHub Actions workflow will automatically:

   • Create a new GitHub release
   • Generate release notes based on merged pull requests
   • Build and push Docker images

4. Review the auto-generated release notes on GitHub and make any necessary edits.

5. Publish the release on GitHub.

This automated process ensures that our changelog is always up-to-date and reflects all the changes made in each release. It reduces manual work and helps maintain consistency in our release notes.

Remember to write clear and descriptive PR titles and use appropriate labels, as these will directly contribute to the quality of our release notes.

💥 Contributing

We welcome contributions from the community! Please follow these steps if you would like to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Create a pull request describing your changes.

🧰 License

This project is licensed under the MIT License. See the LICENSE file for details.