Delivery Solution is a .NET 7 application that provides endpoints to manage deliveries. It is following the DDD pattern. It consists therefore of 4 main projects:
DeliveryApi: the API layer that exposes the endpoints.DeliveryDomain: the business logic layer that contains the domain models and services.DeliveryInfrastructure: the infrastructure layer that deals with data persistence using MongoDB and message queues using RabbitMQ.DeliveryBackground: the background task that updates expired deliveries state every hour.
There are also 3 Unit Tests projects:
DeliveryApiTests: tests the Delivery endpoints.DeliveryDomainTests: tests the business logic.DeliveryInfrastructureTests: tests the database and message broker operations.
- Docker (otherwise you can run it on your IDE)
- Clone the repository to your local machine:
git clone https://github.com/fabio1623/GlueHome.git - Open a terminal and navigate to the
DeliverySolutiondirectory. - Build the solution with the following command:
docker-compose build - Start the application by running:
docker-compose up -d - The Delivery API documentation can be accessed at
http://localhost:80/swagger/index.html - To stop the application, run the following command:
docker-compose down
The above command will start the application as well as all required services.
The following three users are automatically generated to interact with different permissions:
Admin(username: admin, password: admin): manage users and delete deliveriesUser(username: user, password: user): create, get, approve, and cancel deliveriesPartner(username: partner, password: partner): create, get, complete, and cancel deliveries
1000 deliveries will be randomly generated with different states.
To interact with the API endpoints, you can use tools like Postman or cURL.
POST /users/authenticate- Authenticate user.GET /users- Gets paged users.GET /users/{userID}- Gets the user by user id.
It uses a Bearer Token.
POST /deliveries/create- Creates a new delivery.GET /deliveries- Gets paged deliveries.GET /deliveries/{deliveryId}- Gets the delivery by delivery id.PUT /deliveries/approve/{deliveryId}- Approves the delivery.PUT /deliveries/complete/{deliveryId}- Completes the delivery.PUT /deliveries/cancel/{deliveryId}- Cancels the delivery.DELETE /deliveries/{deliveryId}- Deletes the delivery by delivery id.
The users and deliveries are stored in MongoDB. You can visualize the MongoDB instance by reaching http://localhost:8081, using the following credentials:
- Username: basic-user
- Password: basic-user-password
The delivery updates (Created, Approved, Completed, Cancelled, and Deleted) will be pushed to the RabbitMQ exchange.
You can interact with it through http://localhost:15672, using following credentials :
- Username: guest
- Password: guest
If you want to see transiting messages, you can bind a queue to delivery-exchange exchange with * as routing key to see messages.
Expiring deliveries are also pushed to RabbitMQ through delivery-exchange-expiry exchange with * as routing key.
The Delivery Solution logs information to Elasticsearch. To view the logs, follow these steps:
- Open Kibana at
http://localhost:5601 - Create an index pattern with
delivery-api-* - Explore the logs in Kibana.
- Open a terminal and navigate to the
DeliverySolutiondirectory. - Build the test projects with the following command:
dotnet build - Run the tests with the following command:
dotnet test
The above command will start the test runners and run all the tests in the solution.
The Delivery Solution is a containerized application that stores deliveries in MongoDB and sends delivery updates to RabbitMQ. It provides a RESTful API to create, get, update, and delete deliveries. The solution also includes unit tests to ensure the business logic is working as expected.
This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. See the LICENSE file for details.