Skip to content

Sample Nestjs Microservices application, based on a simplified Vertical Slice Architecture and best practices using Nestjs and Nodejs.

Notifications You must be signed in to change notification settings

imatiqul/nestjs-microservices

Repository files navigation

Issues MIT License LinkedIn


Logo

Nestjs Microservices

Sample Nestjs Microservices application, based on a simplified Vertical Slice Architecture and best practices using Nestjs and Nodejs.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

While designing architecture of REST API using Nestjs, we need to consider following areas

Areas Node.js
API Security Nestjs JwtModule
API Versioning Nestjs URL Versioning
API Validation Nestjs ValidationPipe
API Documentation Nestjs OpenApi
Using DTOs (Object to Object Mapper) TypeORM
CORS Policy Nestjs CORS
Health Check Healthchecks (Terminus)
Dependency Injection Built-in DI
Logging Nestjs-OpenTelemetry
ORM TypeORM
CQRS pattern Nestjs CQRS
JSON Serialization class-transformer
Cross-cutting API calls Nestjs ClientProxy
Handle Errors Globally useGlobalFilters
Keep common code paths fast Middleware
Caching Nestjs Caching
Data Protection Nestjs Security
Avoid blocking calls Asynchronous providers
Complete long-running Tasks outside of HTTP requests Nestjs Schedule

Here's why:

  • Vertical Slice Architecture
  • Best practices for Microservices
  • Low Code

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap the project.

(back to top)

Getting Started

Instructions on setting up the project locally.

Prerequisites

  • Node.js
  • npm
    npm install npm@latest -g
  • yarn
    npm install yarn -g

How to Run

Below is the instructions of how you can install and run the app.

  1. Clone the repo
    git clone https://github.com/imatiqul/nestjs-microservices.git
  2. Run project
    yarn
    yarn start

(back to top)

Usage

(back to top)

Roadmap

(back to top)

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/mf-feature)
  3. Commit your Changes (git commit -m 'Add some mf-feature')
  4. Push to the Branch (git push origin feature/mf-feature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

ATIQUL ISLAM - @ATIQ - [email protected]

Project Link: https://github.com/imatiqul/nestjs-microservices

(back to top)

Acknowledgments

(back to top)

About

Sample Nestjs Microservices application, based on a simplified Vertical Slice Architecture and best practices using Nestjs and Nodejs.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published