Nestjs Rest Api Boilerplate

Overview

The NestJS REST API template v1 is a template designed for users in Korea. It provides a complete set of features and functionalities required to quickly build a REST API using NestJS framework. The template includes support for various databases, authentication methods, social logins, role customization, authorization using JWT, error logging, Swagger documentation, unit testing, and more.

Features

• Database (TypeORM): Supports MySQL database with seeding capability.
• Local Authentication: Provides local authentication functionality.
• OAuth (Social Login): Supports social login using Kakao, Naver, Google, and Github.
• Customizing Roles: Allows customization of roles such as admin, user, etc.
• JWT Authorization: Implements JWT authorization for secure access control.
• Slack Alert: Sends alerts to Slack when any error occurs.
• Logging (winston): Includes logging using Winston library.
• Swagger: Automatically generates Swagger documentation for API endpoints.
• Validate DTOs with Entities: Validates Data Transfer Objects (DTOs) with entities.
• Unit Test (Jest): Includes unit testing using the Jest framework.
• E2E Test: Supports end-to-end (E2E) testing.
• File Upload: Supports file upload functionality.
• Mailing: Includes mailing feature.
• CI: Supports continuous integration.
• Example Domain: Template includes an example domain of a board with content.

Summary

The NestJS REST API template v1 is a comprehensive template for building REST APIs using NestJS in a quick and efficient manner. It provides a wide range of features and functionalities such as database support, authentication, social login, role customization, authorization, error logging, documentation generation, testing, file upload, mailing, continuous integration, and more. The template includes an example domain of a board with content and supports customization through the use of environment variables.