Release v0.0.4

Release v0.0.4

Overview

This release includes significant updates to the README file, providing a more structured and detailed overview of the project. The changes aim to improve the clarity and usability of the documentation for new and existing users.

Changes

Documentation

• Enhanced README Structure: The README file has been refactored to follow a more organized structure, making it easier to navigate and understand.
  • Getting Started: Clear instructions on how to clone the repository, install dependencies, and set up the environment.
  • Generating RSA Key Pair: Detailed steps for generating RSA keys for JWT authentication using OpenSSL.
  • Running the Application: Instructions for running the application in both development and production modes.
  • Features: A comprehensive list of the key features of the project, including modularity, scalability, and logging.
  • Project Structure: A detailed breakdown of the project directory structure, explaining the purpose of each file and directory.
  • Contributing: Guidelines for contributing to the project.
  • License: Information about the project's MIT license.

Exclusions

• Dependency Updates: No changes to project dependencies.
• Instruction File Changes: No changes to other instructional files.

New Features

• Modular Design: The project structure follows a modular approach, organizing files into directories based on their functionalities.
• Scalability: The modular structure allows for easy scalability as the application grows.
• Global Exception Handling: Includes global exception filters to catch and handle exceptions across the application.
• Configuration Management: Centralized management of environment variables and application configuration using @nestjs/config.
• Clustering: Support for clustering to utilize multiple CPU cores for improved performance.
• Logging: Integration of nestjs-pino for efficient and customizable logging.
• Swagger Documentation: Integration of Swagger for generating interactive API documentation.
• Linting and Formatting: Configuration files for ESLint and Prettier to enforce consistent code style and catch potential errors.
• Docker Support: Dockerfile for containerization, making it easier to deploy and run the application in different environments.

Bug Fixes

• None: No bug fixes in this release.

Improvements

• Documentation: Improved clarity and usability of the README file.

Notes

This release focuses on enhancing the documentation to provide a better onboarding experience for new users and to help existing users understand the project structure and features more effectively.

---

For more details, please refer to the README.md file.

NestJS Starter Kit v0.0.3 - Major Package Updates

Release Note

Updated Packages

The following package has been updated in this release:

• @nestjs/common: Updated from ^10.2.0 to ^10.3.0
• @nestjs/config: Updated from ^3.0.0 to ^3.1.1
• @nestjs/core: Updated from ^10.2.0 to ^10.3.0
• @nestjs/jwt: Updated from ^10.1.0 to ^10.2.0
• @nestjs/mongoose: Updated from ^10.0.1 to ^10.0.2
• @nestjs/platform-express: Updated from ^10.2.0 to ^10.3.0
• @nestjs/swagger: Updated from ^7.1.8 to ^7.1.17
• axios: Updated from ^1.4.0 to ^1.6.5
• mongoose: Updated from ^7.4.3 to ^7.6.7
• nestjs-pino: Updated from ^3.4.0 to ^3.5.0
• pino: Updated from ^8.15.0 to ^8.17.2
• pino-http: Updated from ^8.4.0 to ^8.6.1
• reflect-metadata: Updated from ^0.1.13 to ^0.1.14
• rimraf: Updated from ^5.0.1 to ^5.0.5
• mongoose: Updated from ^7.6.7 to ^8.0.3

Updated DevDependencies

The following devDependencies have been updated in this release:

• @commitlint/cli: Updated from ^17.7.1 to ^17.8.1
• @commitlint/config-conventional: Updated from ^17.7.0 to ^17.8.1
• @nestjs/cli: Updated from ^10.1.12 to ^10.2.1
• @nestjs/schematics: Updated from ^10.0.2 to ^10.0.3
• @nestjs/testing: Updated from ^10.2.0 to ^10.3.0
• @types/express: Updated from ^4.17.17 to ^4.17.21
• @types/supertest: Updated from ^2.0.12 to ^2.0.16
• eslint: Updated from ^8.47.0 to ^8.56.0
• eslint-config-prettier: Updated from ^9.0.0 to ^9.1.0
• eslint-plugin-import: Updated from ^2.28.1 to ^2.29.1
• eslint-plugin-prettier: Updated from ^5.0.0 to ^5.1.2
• pino-pretty: Updated from ^10.2.0 to ^10.3.1
• prettier: Updated from ^3.0.0 to ^3.1.1
• ts-loader: Updated from ^9.4.4 to ^9.5.1
• ts-node: Updated from ^10.9.1 to ^10.9.2
• typescript: Updated from ^5.1.6 to ^5.3.3
• @commitlint/cli: Updated from ^17.8.1 to ^18.4.4
• @commitlint/config-conventional: Updated from ^17.8.1 to ^18.4.4
• @types/supertest: Updated from ^2.0.16 to ^6.0.2
• @typescript-eslint/eslint-plugin: Updated from ^5.62.0 to ^6.17.0
• @typescript-eslint/parser: Updated from ^5.62.0 to ^6.17.0
• eslint-plugin-unused-imports: Updated from ^2.0.0 to ^3.0.0
• lint-staged: Updated from ^14.0.0 to ^15.2.0

Please refer to each package's release notes for details on what has changed. It's important to test your application after updating these packages, as they may introduce breaking changes.

V0.0.2

Dependency upgrade

• chore(deps): update typescript-eslint monorepo to v5.60.1
• chore(): update dependency ts-loader to v9.4.4
• chore(deps): update dependency lint-staged to v13.2.3
• chore(deps): update dependency @nestjs/cli to v10.0.5

Fixes

LoggerModule -> forRootAsync is not working with ConfigService in nestjs-pino so forRootAsync -> forRoot

v0.0.1

Release Note - Version 0.0.1

New Features

• Added modularity to the project structure, organizing files into directories based on functionalities.
• Implemented scalability by allowing easy addition of new modules, controllers, services, and components.
• Improved separation of concerns by assigning clear responsibilities to each file in the project.
• Included global exception handling filters to catch and handle exceptions across the application.
• Integrated @nestjs/config for centralized management of environment variables and application configuration.
• Implemented clustering support for utilizing multiple CPU cores, improving performance and scalability.
• Added nestjs-pino for efficient and customizable logging capabilities.
• Integrated Swagger for generating interactive API documentation.
• Configured ESLint and Prettier for code style consistency and error detection.
• Added Docker support for easier deployment and execution in different environments.