A progressive Node.js framework for building efficient and scalable server-side applications.

🧩 Project Overview

This template implements a Microkernel (Plug-in) architecture with NestJS. It enables modular design, dynamic feature loading, and scalable domain separation. It’s well-suited for building feature-rich and extensible backend systems.

🏗 Architecture Concept

This system is divided into 3 major containers:

• Core Container

  • Coordinates plugin lifecycle and provides core services (Logger, Registry, Loader).

• Plugin Container

  • Holds feature modules (User, Product, etc.), each as an independent plugin.

• Infrastructure Container

  • Provides shared infrastructure like database connections using DatabaseFactory.

The structure promotes low coupling, testability, and scalability.

🧱 Project Structure

Based on the architecture graph, here’s the folder layout:

├───src
│   ├───core
│   │   ├───core.module.ts
│   │   ├───core.service.ts
│   │   ├───logger
│   │   │   └───logger.service.ts
│   │   ├───plugin
│   │   │   ├───plugin.registry.ts
│   │   │   └───dynamic.loader.ts
│   │   └───core.interface.ts
│   │
│   ├───plugins
│   │   ├───user
│   │   │   ├───user.module.ts
│   │   │   ├───user.controller.ts
│   │   │   ├───user.service.ts
│   │   │   ├───user.repository.ts
│   │   │   └───user.entity.ts
│   │   └───product
│   │       ├───product.module.ts
│   │       ├───product.controller.ts
│   │       ├───product.service.ts
│   │       ├───product.repository.ts
│   │       └───product.entity.ts
│   │
│   ├───infrastructure
│   │   ├───database
│   │   │   ├───database.module.ts
│   │   │   ├───database.factory.ts
│   │   │   ├───sqlite
│   │   │   ├───postgres
│   │   │   └───mysql
│   │
│   ├───shared
│   └───main.ts
└───test

🧩 Plugin Development Guide

When developing a new plugin, follow the steps below:

1. Create a directory under src/plugins, e.g., order

2. Implement the following components:

   • order.module.ts
   • order.controller.ts
   • order.service.ts
   • order.repository.ts
   • order.entity.ts

3. Register the plugin in the PluginRegistry

4. (Optional) Implement the initialize() and shutdown() lifecycle hooks

5. For logging, use LoggerService via dependency injection (DI)

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Da-Wei Lin
• Website - David Weblog
• Twitter - @nestframework

License

Nest is MIT licensed.