Skip to content

rezabashiri/message-dispatcher

Repository files navigation

Message dispatcher template

An easy to use template to show how to develop a message dispatcher by .net 6 Report Bug · Request Feature

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

About The Project

There are many separate project in .net comunity to structure of clean code, CQRS, background jobs and message dispatchers but i couldnt find one to include all those topics all together, so I decided to develop a structure to show how to group all those concepts and principles in a single easy to use project

What you will achieve :

  • A clean code and Multi-Tiered structure
  • Hangfire installed and configured to do back ground jobs
  • CQRS pattern enabled by using of MediatR library
  • Unit and integration tests
  • Configuration and usage of AutoMapper library
  • Good example of how to use docker compose to connect two project by docker compose

This project aimed to show basics of some most complicated and high demand concepts of development in these days, and it's down to you to develop it and get of it in your project!

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • dotnet
    dotnet build ./"Message Dispatcher.sln"

Installation

Below is how you can run your project via docker compose.

  1. Clone the repo
    git clone https://github.com/rezabashiri/message-dispatcher.git
  2. Run docker
    docker compose up -d
  3. Head to https://localhost:9001

To run integration tests succefully, you need to run project by visual studio through docker compose and then run integration tests (those tests are connecting to API faker project to fetch data

(back to top)

Roadmap

  • Add API faker
  • Add CQRS pattern
  • Add hangfire
  • Add comments
  • Add authentication and authorization via openiddict as a separate service to project

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Reza Bashiri - https://rezabashiri.com/ - rzbashiri@gmail.com - Linkedin

Project Link: https://github.com/rezabashiri/message-dispatcher

(back to top)

About

If you are looking a complete and functional project template or need a best practice to extend your knowledge about concepts of 1-CQRS 2- Queueing 3- Message dispatchers, this repository is good for you

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors