Nestjs Boilerplate

Theme by Vndevteam

|

Updated: 18 Dec 2024

|

198 Stars

NestJS boilerplate with TypeORM, ExpressJS, Fastify, Jest, I18n & Vuepress docs

Categories

Overview:

This NestJS boilerplate is designed for typical projects, offering a variety of features to streamline development. It includes support for Fastify, TypeORM for database, seeding with Typeorm Extension, configuration services, mailing functionalities, email sign-in/sign-up, pagination, internationalization, Swagger documentation, testing, Docker, and CI integration through Github Actions.

Features:

• Fastify support: Utilize the feature.fastify branch for Fastify integration.
• Database support: Implemented with TypeORM for seamless database management.
• Seeding: Includes Typeorm Extension for data seeding.
• Config Service: Benefit from configuration services provided by @nestjs/config.
• Mailing functionality: Integrated with @nestjs-modules/mailer & nodemailer for email features.
• Sign in and sign up via email: User authentication via email credentials.
• Pagination: Offset and Cursor pagination features, expanding on typeorm-cursor-pagination.
• Internationalization/Translations (I18N): Leverages the nestjs-i18n plugin for multi-language support.
• Swagger documentation: Features Swagger for API documentation.
• E2E and unit tests: Includes testing capabilities for thorough code evaluation.
• Docker support: Allows for containerized deployment of the application.
• CI integration: Github Actions for continuous integration setup.

Installation:

To install this NestJS boilerplate, follow these steps:

1. Clone the repository.
2. Change the author name in the LICENSE file.
3. Update configurations in the .env file.
4. Clean up the .github folder.
5. Customize the README.md file to suit your project requirements.
6. Follow the detailed documentation provided for additional guidance on project structure and conventions.

Summary:

This NestJS boilerplate offers a comprehensive foundation for developing NestJS projects, incorporating essential features such as database support, seeding, configuration services, mailing capabilities, pagination, internationalization, Swagger documentation, testing functionalities, Docker support, and CI integration. By following the installation checklist and exploring the detailed documentation, developers can efficiently set up and customize their projects using this boilerplate.