https://github.com/makampos/uttom

This API provides management for motorcycle rentals.
https://github.com/makampos/uttom

api-rest entity-framework-core fluentvalidation masstransit mediatr minio nsubstitute postgres testcontainers xunit

Last synced: 6 months ago
JSON representation

This API provides management for motorcycle rentals.

• Host: GitHub
• URL: https://github.com/makampos/uttom
• Owner: makampos
• License: mit
• Created: 2024-10-14T19:43:29.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T20:34:08.000Z (12 months ago)
• Last Synced: 2024-10-24T07:26:45.882Z (12 months ago)
• Topics: api-rest, entity-framework-core, fluentvalidation, masstransit, mediatr, minio, nsubstitute, postgres, testcontainers, xunit
• Language: C#
• Homepage:
• Size: 602 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Running the Project

To get started, follow these steps:

1. **Navigate to the Project Directory**:  

   Open your terminal and change to the directory containing the `docker-compose.yml` file (**Uttom.Infrastructure**).

2. **Start the Containers**:  

   Execute the command:

   ```bash

   docker compose up -d

   

This command will pull the necessary dependencies and start all defined containers.

### Access the API:

Once the containers are running, you can launch the **Uttom.API** project. The **Swagger UI** will open automatically, allowing you to explore and interact with various API endpoints.

### Accessing External Services

- **MinIO storage** is available at:  

  [http://localhost:9090/browser/](http://localhost:9090/browser/)

- **RabbitMQ** is available at:  

  [http://localhost:15672/#/](http://localhost:15672/#/)

All services use default credentials. Check the `docker-compose` file to retrieve them.

### Tools Used

The project makes use of the following tools and libraries:

- **FluentValidation**

- **MediatR**

- **OpenApi**

- **EntityFrameworkCore**

- **Inflector**

- **MassTransit**

- **RabbitMQ**

- **xUnit**

- **Npgsql.EntityFrameworkCore.PostgreSQL**

- **Testcontainers**

- **FluentAssertions**

- **Testcontainers.Minio**

- **Testcontainers.PostgreSql**

- **Testcontainers.RabbitMq**

- **NSubstitute**

### Technical Information

The project has over 80 tests (many more can be added), which include:

- **Integration Tests**:  

  Utilizing **TestContainers** to spin up instances of **PostgreSQL**, **RabbitMQ**, and **MinIO** for storage during testing.

- **Unit Tests**:  

  Implementing **NSubstitute** for mocking **RabbitMQ** interactions and using an in-memory database for persistence.