Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mrathod05/nestjs-toolkit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🛠️ NestJS Toolkit

A simple, flexible toolkit to kickstart your NestJS projects with essential configurations and integrations.

nestjs-toolkit helps you quickly set up common integrations like Swagger, CORS, Database configurations, and more — saving you time on boilerplate code so you can focus on building your application. 🚀

🧰 Features

📖 Swagger Setup: Automatically sets up Swagger API documentation for your NestJS project.
🌐 CORS Configuration: Easily manage CORS settings for your NestJS APIs.
💾 Database Configuration: Integrates with MongoDB, PostgreSQL, or other databases with pre-configured settings.
🔧 Main.ts Boilerplate: Automatically creates a main.ts file with standard configurations for CORS, validation, error handling, and more.
⚠️ Global Exception Filter: Pre-configured exception filter for centralized error handling.
📦 NestJS CLI: Simple CLI tool to generate the boilerplate code for setting up your NestJS projects.

🚀 Installation

To install nestjs-toolkit, you can either install it globally or as a dev dependency.

Install Globally

npm install -g @mrathod05/nestjs-toolkit

or directly

npx nestjs-toolkit

🛠️ Usage

1. Create NestJS Boilerplate Code1. Create NestJS Boilerplate Code

Run the nestjs-toolkit CLI tool to automatically set up all the required boilerplate files for your NestJS project.

npx nestjs-toolkit

This gives you option

🔥 Your plug-n-play toolkit for NestJS.

? What would you like to set up? ›
❯ Exception Filter
  Swagger Setup
  DB Config
  CORS Config
  Set main.ts
  All of the above
  Exit

You can select the desired components to set up, such as:

Exception Filter ⚠️: Set up a global exception handler for your NestJS project to handle errors and exceptions consistently.
Swagger Setup 📖: Automatically configure Swagger for API documentation.
DB Config 💾: Set up your database configuration for seamless integration.
CORS Config 🌐: Configure CORS settings to allow cross-origin requests.
Set main.ts 🔧: Set up the main.ts file with essential configurations.

If you select All of the above, the tool will generate all the necessary files for you automatically.

💡 Why Use nestjs-toolkit?

Quick Setup: Get up and running with essential configurations like Swagger, CORS, and database integration in minutes.
Flexible: Works with MongoDB, SQL, PostgreSQL, or any database of your choice.
Reliable: Pre-configured exception handling and error management with the global exception filter.

🧑‍💻 Developer

Meet Rathod