🎉 Welcome to the NestJS Base Template! 🎉

---

🚀 Kickstart your NestJS journey with this comprehensive template! 🚀

This template is designed to provide you with a solid foundation for building scalable and maintainable server-side applications using NestJS. It comes packed with essential features to streamline your development process.

---

✨ Features ✨

---

• 🔀 Dual ORM Support:

  • Prisma: Available in the master branch for a modern and intuitive ORM experience.
  • TypeORM (need updates) : Available in the typeorm branch for those who prefer a more traditional ORM approach.
  • MongoDB Support: Just change db provider in prisma/schema.prisma and enjoy MongoDb :))

• 🌐 API Support:

  • REST API: Available in master branch for classic REST approach
  • GraphQL API: Available in graphql branch with full GraphQL support
  • Hybrid Mode: Ability to use both REST and GraphQL simultaneously

• 📊 GraphQL Features (in graphql branch):

  • Code-First Approach: Automatic schema generation from TypeScript classes
  • Type Safety: Full TypeScript support with automatic type generation
  • Subscriptions: Real-time support via WebSocket
  • Playground: Built-in GraphQL IDE for query testing
  • Schema Stitching: Ability to combine multiple GraphQL schemas

• 🔑 JWT Authentication: Authorization is handled using JWT and passport-jwt, ensuring secure and stateless authentication.

• 🛡️ Role-Based Access Control: Effortlessly manage user roles and permissions to ensure the right access levels.

• 🌐 Internationalization Support: Seamlessly support multiple languages and locales to reach a global audience.

• 📜 Swagger | GraphQL Documentation: Automatically generated API documentation to help you and your team understand and use the API effectively.

• 🛠️ Modular Architecture: Clean and organized structure to facilitate scalability and maintainability.

• ⚡ High Performance: Optimized for speed and efficiency, ensuring your application runs smoothly.

---

📘 Introduction

This template is structured to help you quickly start developing your NestJS application. Here's how you can make the most of it:

• Apps: Add new apps in the apps directory. Each app should encapsulate related functionality, including modules, common types, guards, interceptors, etc.

• Modules: Add new features by creating modules in the app-name/src/modules directory. Each module should encapsulate related functionality, including controllers, services, and repositories.

• Controllers: Define your API endpoints in controllers. Place them in the respective module's directory under app-name/src/modules.

• Services: Implement your business logic in services. These should also be placed within the module's directory.

• Repositories: Interact with the database using repositories. Define them in the module's directory and use Prisma or TypeORM for database operations.

• DTOs (Data Transfer Objects): Define DTOs in the dto directory within each module to validate and type-check incoming data.

• Guards and Interceptors: Implement guards and interceptors in the libs/common/src/guards directory to handle cross-cutting concerns like authentication and logging.

• Configuration: Manage application configuration using the ConfigModule in apps/app-name/src/config. Environment variables can be defined in .env files.

• Internationalization: Add translations in the libs/i18n directory to support multiple languages.

• Swagger | GraphQL Documentation: Automatically generate API documentation by annotating your controllers and DTOs with Swagger decorators.

---

📦 Project Structure

• apps/ - Separate applications

  • main/ - Main API application
  • admin/ - Administrative API

• libs/ - Shared libraries

  • common/ - Common utilities and types
  • i18n/ - Internationalization module
  • users/ - Users module
  • token/ - JWT tokens module
  • permissions/ - Permissions module
  • role/ - Role module
  • prisma/ - Prisma ORM module
  • password/ - Password hashing module

---

📚 Applications Structure

Main API (apps/main)

• Primary API application
• Port: 3000
• Swagger: http://localhost:3000/api

Admin API (apps/admin)

• Administrative API
• Port: 3001
• Swagger: http://localhost:3001/api

---

🚀 Getting Started

To get started with this template, follow these steps:

1. Create Your Repository: This is a GitHub template repository. Use it to create your own repository by clicking the "Use this template" button on GitHub.

2. Clone Your Repository: Clone your newly created repository to your local machine.

   git clone <your-repository-url>

3. Install Dependencies: Navigate to the project directory and install the necessary dependencies.

   cd <your-repository-name>
   npm install

4. Set Up Environment Variables: Create a .env file in the root directory and configure your environment variables. Refer to .env.example for guidance.

5. Database Setup: Ensure your database is running and configured correctly. Use Prisma or TypeORM migrations to set up your database schema.

6. Run the Application: Start the application in development mode.

   npm run start:dev

7. Access Swagger Documentation: Visit http://localhost:<3000/3001>/api to view the automatically generated Swagger documentation.

8. GraphQL Playground: Visit http://localhost:<3000/3001>/graphql to view the GraphQL playground.

9. Explore and Customize: Explore the codebase, add new features, and customize the template to fit your project needs.

---

Explore these features and more to build a powerful and flexible application with NestJS! 🚀