CQRS, Domain-Driven Design & Event Sourcing Inspired Order Fulfillment API

This will be the Order Fulfillment REST API that will handle the orders placed from the Shopping Cart API.

Description

Our goal is to show how CQRS and Event Sourcing works but with minimal configuration so instead of asking you
to install MySQL or MongoDB we will just use SQLite3 for data storage. The domain codes are unit tested and we are using
Hexagonal Architecture. We also used Symfony’s Dependency Injection Component
for easy configuration of parameters and service.

This repository will play as your Order Fulfillment System (Or whatever it is called) REST API server.

Orders can be created via published Domain Events or via the create order API end point. Orders are manipulated via the
projection generators. The state of the Orders are not saved, only the events relevant to it.

Built With

• PHP
• Lumen Framework
• RabbitMQ
• Python3

Requirements

• Docker

Installation

• Run docker-compose build
• Run docker-compose run --rm composer install

Starting the application

• Run docker-compose up -d server to start the Node and NGINX servers as daemon.
• Run docker-compose run --rm php artisan migrate:fresh --seed in a separate command line interface.
• Run docker-compose run --rm -T php artisan fulfillment:projection_generator in a separate command line interface to
  start the event listener that updates the projection tables.
• Run docker-compose run --rm python main.py in a separate command line interface to start the mock e-mail sending event listener.

How to use

You can use the content of the OpenAPI specification of the REST API in the following:

• Swagger Editor
• Postman

Test login credentials.

• Username: employee
• Password: password

Using Swagger as testing tool and when all listeners are running. Your screen may look like this:

The swagger.yml host is already http://localhost:8000 by default. So no need to configure much and just test the application.
Keep the application is using the default credentials of RabbitMQ (guest/guest) so no need to configure it too. Also keep the
Shopping Cart API application up and running together with this application.

Built With

• PHP
• Lumen Framework
• RabbitMQ

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

• Erickson Reyes - Initial work - ericksonreyes

License

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