NestJS Boilerplate Create

A simple CLI tool to quickly scaffold a NestJS project from a prebuilt boilerplate.
It saves time by setting up the boilerplate structure, installing dependencies, and preparing the project for development.

📦 Prerequisites

Before using this tool, make sure you have installed:

1. Node.js (v16 or later) → Download here
2. npm (comes with Node.js)
3. Git → Download here

🚀 Usage

To create a new project, run:

npx nestjs-boilerplate-backend <project-name>

⚙️ Environment Setup

Before running the project, create a .env file inside the project root with the following configuration:

# Database Configuration
DB_HOST= 
DB_PORT=
DB_USERNAME=
DB_PASSWORD=
DB_NAME=

# Global API prefix
API_GLOBAL_PREFIX=api

# Redis Configuration
REDIS_HOST=
REDIS_PORT=

👉 A .env.example file is also provided in the project for quick reference.

▶️ Run the Project

Start the NestJS application in development mode:

npm run start:dev

🤝 Contributing

Feel free to open issues and pull requests to improve this boilerplate.