Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 8.35 KB

README.md

File metadata and controls

179 lines (125 loc) · 8.35 KB
Raw

.NET Microservices Boilerplate

fluentpos

The goal is to build a framework that can make building microservices in .NET easy for developers. This project follows Vertical Slice Architecture along with other latest best practices and tools like CQRS, NoSQL, SQL, MediatR, Serilog, FluentValidations and more.🚀

Table of Contents

Goals

  • ❇️ Using Vertical Slice Architecture for architecture level.
  • ❇️ Using Domain Driven Design (DDD) to implement all business processes in microservices.
  • ❇️ Using Rabbitmq on top of MassTranit for Event Driven Architecture between our microservices.
  • ❇️ Using CQRS implementation with MediatR library.
  • ❇️ Using Entity Framework Core for some microservices.
  • ❇️ Using MongoDB for some microservices.
  • ❇️ Using Fluent Validation and a Validation Pipeline Behaviour on top of MediatR.
  • ❇️ Using Minimal API for all endpoints.
  • ❇️ Using Health Check for reporting the health of app infrastructure components.
  • ❇️ Using Tye for local development and debugging.
  • ❇️ Using Built-In Containerization for Docker images.
  • ❇️ Using Zipkin for distributed tracing.
  • ❇️ Using OpenIddict for authentication and authorization base on OpenID-Connect and OAuth2.
  • ❇️ Using Yarp as a microservices gateway.

FluentPos

FluentPos is a sample project that consumes the microservice framework. You will learn a lot by exploring this project, which is located under the ./fluentpos folder.

Services Status
Gateway Completed ✔️
Identity Completed ✔️
Catalog Completed ✔️
Cart WIP 🚧
People WIP 🚧
Ordering WIP 🚧
Payment WIP 🚧

How to Run ?

Tye

Tye is a super-awesome way to run your applications quickly. The fluentpos project already has this support. Simply run the following at the ./fluentpos directory :

make tye

That's it!

This will spin up all the services required.

  • Gateway will be available on https://localhost:7002.
  • Identity Service will be available on https://localhost:7001.
  • Catalog Service will be available on https://localhost:7003.

To Test these APIs, you can use open up Visual Code from the ./fluentpos directory, install the Thunder Client extension. I have already included the required Test collections at ./fluentpos/thunder-tests.

You can find the specification of services under the ./fluentpos/tye.yaml file.

Docker & Docker-Compose

The fluentpos project comes included with the required docker-compose.yaml and makefile file for your reference.

There are some prerequisites for using these included docker-compose.yml files:

  1. Make sure you have docker installed (on windows install docker desktop)

  2. Create and install an https certificate:

    dotnet dev-certs https -ep $env:USERPROFILE\.aspnet\https\cert.pfx -p password!

    Note that the certificate name and password should match the ones that are mentioned in the docker-compose.yaml file.

  3. It's possible that the above step gives you an A valid HTTPS certificate is already present error. In that case you will have to run the following command, and then Re-Run Step #2.

     dotnet dev-certs https --clean

  4. Trust the certificate

     dotnet dev-certs https --trust

Once your certificate is trusted, simply navigate into the ./fluentpos folder of the project and run the following command.

make docker-up

This will spin up all the containers required. Your Gateway URL will be available on https://localhost:7002.

To bring down all the fluentpos container, simply run the following.

make docker-down

Note that the default Docker Images that will be pulled are from my public Image Repository (for eg, iammukeshm/fluentpos.identity:latest). You can switch it your variants if required.

Technologies & Libraries

  • .NET 7 - .NET Framework and .NET Core, including ASP.NET and ASP.NET Core
  • MVC Versioning API - Set of libraries which add service API versioning to ASP.NET Web API, OData with ASP.NET Web API, and ASP.NET Core
  • EF Core - Modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations
  • MediatR - Simple, unambitious mediator implementation in .NET.
  • FluentValidation - Popular .NET validation library for building strongly-typed validation rules
  • Swagger & Swagger UI - Swagger tools for documenting API's built on ASP.NET Core
  • Serilog - Simple .NET logging with fully-structured events
  • OpenIddict - OpenIddict aims at providing a versatile solution to implement OpenID Connect client, server and token validation support.
  • Mapster - Convention-based object-object mapper in .NET.
  • Yarp - Reverse proxy toolkit for building fast proxy servers in .NET
  • Tye - Developer tool that makes developing, testing, and deploying microservices and distributed applications easier.
  • MongoDB.Driver - .NET Driver for MongoDB.

Documentation

Read Documentation related to this Boilerplate here - https://fullstackhero.net/dotnet-microservices-boilerplate/

Feel free to contribute to the Documentation Repository - https://github.com/fullstackhero/docs Docs are not yet updated.

Changelogs

View Complete Changelogs.

Community

License

This project is licensed with the MIT license.

Support ⭐

Has this Project helped you learn something New? or Helped you at work? Here are a few ways by which you can support.

Code Contributors

This project exists thanks to all the people who contribute. Submit your PR and join the elite list!

fsh dotnet microservices contributors

Financial Contributors

Become a financial contributor and help me sustain the project. Support the Project!