/crh-documents-service

Clear Read Hub Document Service

Primary LanguageC#MIT LicenseMIT

Clear Read Hub (CRH) | Documents Service

.NET Build Solution License

Clear Read Hub (CRH) is a microservice architecture application built with FastAPI, following the principles of Domain-Driven Design (DDD).

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • .NET Core 8.0
  • .NET Framework 4.8
  • Docker
  • Docker Compose
  • MongoDB
  • RabbitMQ

Installing

A step by step series of examples that tell you how to get a development environment running.

# Clone the repository
git clone https://github.com/luigi-dv/crh.git

# Navigate into the directory
cd crh

Docker

You can also run the application using Docker. (Will be available soon)

# Build the image
docker build -t crh:latest .

Running the tests

Explain how to run the automated tests for this system.

Deployment

Add additional notes about how to deploy this on a live system.

Built With

  • .NET - The cross-platform framework used.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details