Project aims to refactor the architecture used in the project Neighborfood - Ports and Adapters
- To upload the application, use the docker-compose up or docker-compose up --build command, use a client for the request, the results are also presented via the console to fill in the response.
Through the monolith, I will create an application similar to Ifood.
This application is being developed to prove theories, software development with DDD, every flow developed here is intended only to put into technical practices of domais driven design, I will use docker to upload the application to the PostgreSql database.
I will refactor the previous architecture to a clean architecture.
Clean architecture also says a lot about not dirtying or violating the layers. This architecture is based on using the outermost layer to the innermost ones. To do this, the use of appropriate layers must be followed in order to not harm the proposal brought by the adopted model.
- Doc DDD miro: miro
- Json doc to postman requests: request postman
- Api-docs Swagger OpenPI swagger-ui -> Access documentation only by running the application or by inserting the contents of the src/main/resources/api/resource.yml file on the swagger web editor website
- Video YouTube Application Neighborfood demonstration video
Doc uml diagrams
|
|
|
|
- To execute the project and orchestrate containers, install minikube, the platform used in development and testing.
- Run the minikube start command to access the minikube dashboard, where you can view the containers in a more simplified way.
- With docker-desktop installed, enable the kubernetes engine in docker settings.
- Using the command line via cmd, navigate to the k8s project directory and run the commands kubectl apply -f filename so that applications can upload containers, pods and services.
- Using the command line, cmd, run the command minikube service app-neighborfood-service, this way you will have access to the api document, swagger-openapi Orchestrating containers with minikube, spinning up two instances
NEIGHBORFOOD MENU
- 1 - Register as administrator
- 1.1 - If a user accesses the system and uses areas such as listing the menu or placing an order, the response will be empty and a notification will be sent to admin
- 1.2 - The administrator will be able to list the orders entered regardless of their status, however, only orders with a finalized status will be able to check the waiting time.
- 2 - Register items in stock
- 2.1 - The administrator can register one item per category per batch
- 2.2 - When the customer places an order, the item selected in the order is subtracted from stock
- 3 - Register as a Customer
- 3.1 - You can register using your name, email and CPF, if you do not want to, you will be identified by the order number
- 3.2 – When registering and already having a login, the system will return your current username
- 4 - Log in as a customer
- 5 – List the options menu
- 6 - Place an order
- 6.1 - If a product is missing, the system will notify the customer and the administrative area for replacement
- 6.2 - The customer can make changes to items, updating their order
- 7 - Make payment
- 7.1 - There is a Mercado Pago webhook for us to test the payment, the integration of this service should be well used, it is where we will prove a way to plug the service without harming our layers.
- 8 - Collect your order
- 9 - Receive treats
- 9.1 - You will receive discount alerts on upcoming orders
Happy flow:
- 1 - Register as an administrator
- 2 - Register products
- 3 - Register as a customer
- 4 - Place an order
- 5 - Update your order if you wish
- 6 - Make payment
- 7 - Check the order status
- 7.1 - When you check the order status after payment, the system will move to the next statuses until the order is finalized
- 8 - Send gifts to the customer
- 9 - List the orders containing the average waiting time
- 10 - You can list the orders at any time, regardless of their status.
Java documentation, generated by Maven, contains detailed information about the technologies used, versions and much more, It can be accessed through the target/site.
