Skip to content

A Bash script to generate a clean, modular, and production-ready structure for NestJS projects.

Notifications You must be signed in to change notification settings

sajad-ahmadnzhad/nest-plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9ee790f Β· Jan 14, 2025

History

84 Commits
Jan 14, 2025
Jan 13, 2025
Jan 14, 2025
Jan 11, 2025

Repository files navigation

🌟 Nest-Plus 🌟

πŸš€ Supercharge Your NestJS Development with Automation, Flexibility, and Elegance!

Powered by Bash NestJS Framework


🌟 Overview

Nest-Plus is the ultimate Bash-powered assistant for developers working with NestJS. It automates tedious tasks, builds a production-ready project structure, and integrates essential tools, letting you focus on coding instead of configuration. Whether you're a beginner or an experienced developer, Nest-Plus takes your productivity to the next level!


🎯 Why Use Nest-Plus?

  • Time-Saving: Automates project setup and configuration, saving hours of manual effort.
  • Flexibility: Supports multiple ORMs, databases, and optional integrations, giving you full control over your stack.
  • Scalability: Generates a modular and maintainable structure, perfect for scaling your applications.
  • Focus on Code: Eliminates setup headaches so you can dive straight into writing business logic.

✨ Key Features

1. Choose Your ORM/ODM

Whether you prefer relational or non-relational databases, Nest-Plus has you covered! You can choose from:

  • TypeORM: Perfect for SQL-based databases like PostgreSQL, MySQL, Mariadb, and SQLite.
  • MikroORM: Lightweight and flexible, ideal for SQL and NoSQL databases.
  • Mongoose: The go-to ODM for MongoDB.
  • No Database: Skip the database setup for lightweight projects or mock environments.

2. Database Support

Supported databases include:

  • PostgreSQL
  • MySQL
  • Mariadb
  • SQLite
  • MongoDB

3. Redis Integration

Enhance performance and scalability with Redis:

  • Redis: Use as a general-purpose caching solution or session storage.
  • Redis Cache Manager: Simplify cache management with built-in NestJS integration.

4. Swagger API Documentation

Generate beautiful and interactive API documentation with Swagger. Impress your team and clients with professional-grade API specs!

5. CORS Configuration

Secure your APIs with customizable CORS settings. Control origins, methods, headers, and credentials to ensure safe cross-origin requests and protect your backend effortlessly with Nest-Plus.

6. Modular Structure

Nest-Plus generates a clean and scalable structure for your NestJS projects:


src/
β”œβ”€β”€ common/
β”‚   β”œβ”€β”€ pipes/
β”‚   β”œβ”€β”€ filters/
β”‚   β”œβ”€β”€ guards/
β”‚   β”œβ”€β”€ middlewares/
β”‚   β”œβ”€β”€ enums/
β”‚   β”œβ”€β”€ decorators/
β”‚   β”œβ”€β”€ utils/
β”œβ”€β”€ configs/
β”œβ”€β”€ modules/
β”‚   β”œβ”€β”€ app/
β”‚       β”œβ”€β”€ app.module.ts
.env
.env.example

πŸ“¦ Installation

git clone https://github.com/sajad-ahmadnzhad/nest-plus/
cd nest-plus
chmod +x main.sh
./main.sh

βš™οΈ How It Works

  1. Run the script using ./main.sh.
  2. Answer the interactive prompts to customize your project:
    • Select your preferred ORM/ODM.
    • Choose your database type (PostgreSQL, MySQL, MongoDB, etc.).
    • Decide whether to integrate Redis or Redis Cache Manager.
    • Enable or disable Swagger API documentation.
  3. Let the script generate a clean, modular, and production-ready NestJS project for you!

🧐 Why Should Developers Use Nest-Plus?

Here’s why Nest-Plus is a game-changer for your projects:

  • Productivity Boost: Spend less time setting up and more time coding.
  • Consistency: Standardized structure ensures clean and maintainable codebases.
  • Customization: Build your project exactly how you want it with interactive options.
  • Scalable Setup: The modular structure and Redis integration ensure your app can handle growth.

✨ Contributions

We ❀️ contributions! Found a bug? Have an idea for a new feature? Open an issue or submit a pull request.


πŸ’¬ Feedback

If you have any questions or feedback, feel free to reach out or open an issue in the repository.

About

A Bash script to generate a clean, modular, and production-ready structure for NestJS projects.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages