farmacy-food-kata

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #golang #machine-learning #rust #nodejs #java #windows #kubernetes #awesome-list #pytorch

farmacy-food-kata

(★ 133)

Team Miyagi's Little Forests solution to the Farmacy Food Architecture Kata

File Explorer

Download Latest Version (.zip)

- ADR001-microservice-style.md
- ADR002-payment-gateway.md
- ADR003-bff-pattern.md
- ADR004-wrapper-pattern.md
- ADR005-cqrs-pattern.md
- ADR006-aws-as-cloud-provider.md
- aws-deployment-view.md
- catalog-microservice-view.md
- context-diagram.md
- customer-pickup-microservice-eda-view.md
- ddd-context-map-to-microservices.md
- ddd-context-map.md
- hexagonal-reference-architecture.md
- order-microservice-eda-view.md
- replenish-microservice-eda-view.md
- user-account-mgmt-microservice-view.md
- view-template.md
- activity-diagram-for-customer-at-pick-up-location.png
- aws-deployment-view-primary.jpg
- catalog-microservice-view-primary.jpg
- components-on-k8s.png
- context-diagram.jpg
- context-map-to-microservices-mapping.jpg
- customer-pickup-microservice-view-primary.jpg
- ddd-context-map-bc-cart-close.png
- ddd-context-map-bc-customer-notification-close.png
- ddd-context-map-bc-inventory-close.png
- ddd-context-map-bc-location-close.png
- ddd-context-map-bc-meal-catalog-close.png
- ddd-context-map-bc-order-close.png
- ddd-context-map-bc-payment-close.png
- ddd-context-map-bc-promotion-close.png
- ddd-context-map-bc-replenish-close.png
- ddd-context-map-bc-review-close.png
- ddd-context-map-bc-subscription-close.png
- ddd-context-map-bc-user-close.png
- ddd-context-map-bc-via-data-replication.png
- ddd-context-map-bc-via-events.png
- ddd-context-map-bc-via-rest-api.png
- ddd-context-map-key.jpg
- ddd-context-map-relationship-acl.png
- ddd-context-map-relationship-conformist.png
- ddd-context-map-relationship-partnership.png
- ddd-context-map-subdomain.png
- ddd-context-map.jpg
- hexagonal-notation-key.jpg
- hexagonal-reference-architecture.jpg
- inventory-db-symbol.png
- inventory-query-view-db-symbol.png
- Miyagi-and-Daniel-san.jpg
- notation-key-microservice-views.png
- order-microservice-eda-view-primary.jpg
- order-microservice-eda-view-sd.jpg
- replenish-microservice-eda-view-primary.jpg
- replenish-microservices-eda-state-machine.png
- state-machine-and-activity-diagram.drawio
- topic-symbol.png
- user-account-mgmt-microservice-view-primary.jpg
- functional-rqmts.md
- quality-attribute-rqmts.md
.gitignore
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

This is the GitHub repo for the solution created by team Miyagi's Little Forests for the 2020 O'Reilly Architectural Kata. It contains a proposed architecture for [Farmacy Food](https://www.farmacyfood.com/).

Team contact: [miyagisforests@gmail.com](mailto:miyagisforests@gmail.com)

Team members:
- Antônio Carvalho
- Eldon Coutinho
- Paulo Merson

The three of us are developers in the IT department of the [Brazilian Federal Court of Accounts](https://portal.tcu.gov.br/en_us/english/inside-tcu/external-control/) 
(TCU). We help design and implement service-based solutions at TCU (from our homes in Brasília these days).

Here's our [five-minute video presentation](https://www.youtube.com/watch?v=11cTCAlidE8) for the O'Reilly Architectural Kata.

---

[![miro board](https://miro.com/static/favicons/apple-touch-icon-57x57.png)][miro-board-link]
Check out our [Miro Board containing all the diagrams below][miro-board-link]. You can also comment on it.

***Questions? Comments?*** Interested in microservices? EDA? DDD? Architecture in general? Feel free to [chime in](https://github.com/miyagis-forests/farmacy-food-kata/discussions)!

---

# Farmacy Food system

### Requirements

This section contains the requirements, distilled from the [provided document](https://docs.google.com/document/d/1SML3n4JbpZV2PSLRpjaCvBvyUMVsFwlqAQF3VKd_oPU/edit#) and  
the interview with the PO, Kwaku Osei, but also with some assumptions we made. These requirements were the main drivers for the design decisions in this proposal.

- [Functional requirements](requirements/functional-rqmts.md)
- [Quality attribute requirements](requirements/quality-attribute-rqmts.md), aka architecture characteristics

### Architecture

Here you find the documentation of the software architecture that we envision to address Farmacy Food's requirements.

As a starting point, there's a context diagram that gives an overview of the external elements that interact with 
what we called the *Farmacy Food System*, which is the scope of this software architecture.

<table>
<tr><td align="center"><a href="architecture/context-diagram.md">Context Diagram<br>
<img src="images/context-diagram.jpg" width="200"></a></td></tr>
</table>

The main part of the software architecture is the set of five *architecture views* seen below. These views provide a runtime 
perspective of the system, that is, they show the components and connectors that have runtime presence and 
altogether correspond to the main capabilities provided by the Farmacy Food system. They follow the microservice and EDA
architecture styles.

<table>
<tr>
    <td align="center"><a href="architecture/user-account-mgmt-microservice-view.md">User Account Management - microservice view<br><img src="images/user-account-mgmt-microservice-view-primary.jpg" width="200"></a></td>
    <td align="center"><a href="architecture/catalog-microservice-view.md">Catalog - microservice view<br>
        <img src="images/catalog-microservice-view-primary.jpg" width="200"></a>
    </td>
</tr>
<tr>
    <td align="center"><a href="architecture/order-microservice-eda-view.md">Order - microservice and EDA view<br>
        <img src="images/order-microservice-eda-view-primary.jpg" width="200"><img src="images/order-microservice-eda-view-sd.jpg" width="200"></a>
    </td>
    <td align="center" valign="middle"><a href="architecture/customer-pickup-microservice-eda-view.md">Customer at pick-up location - microservice and EDA view<br>
        <img src="images/customer-pickup-microservice-view-primary.jpg" width="200"><img src="images/activity-diagram-for-customer-at-pick-up-location.png" width="200"></a>
    </td>
</tr>
<tr>
    <td colspan="2" align="center">
        <a href="architecture/replenish-microservice-eda-view.md">Replenisher - microservice and EDA view<br>
        <img src="images/replenish-microservice-eda-view-primary.jpg" width="200"><img src="images/replenish-microservices-eda-state-machine.png" width="200">
        </a>
    </td>
</tr>
</table>

The following architecture view is a [DDD Context Map](https://learning.oreilly.com/library/view/patterns-principles-and/9781118714706/c07.xhtml). 
It shows how the Farmacy Food system is broken up into bounded contexts (BCs) and how they interact with each other.

<table>
<tr>
    <td align="center"><a href="architecture/ddd-context-map.md">DDD Context Map<br>
        <img src="images/ddd-context-map.jpg" width="200"></a>
    </td>
    <td align="center"><a href="architecture/ddd-context-map-to-microservices.md">DDD Context Map to microservices mapping<br>
        <img src="images/context-map-to-microservices-mapping.jpg" width="200"></a>
    </td>
</tr>
</table>
 
We believe the implementation of each BC can follow the [hexagonal architecture](https://herbertograca.com/2017/11/16/explicit-architecture-01-ddd-hexagonal-onion-clean-cqrs-how-i-put-it-all-together/). 
The following architecture describes how the code of each BC can be structured according to this architecture style.  
 
<table>
<tr><td align="center"><a href="architecture/hexagonal-reference-architecture.md">Hexagonal reference architecture view<br>
<img src="images/hexagonal-reference-architecture.jpg" width="200"></a></td></tr>
</table>

Finally, we have a deployment view that describes the runtime infrastructure for the components seen in the five 
runtime architecture views.

<table>
<tr><td align="center"><a href="architecture/aws-deployment-view.md">AWS deployment view<br>
<img src="images/aws-deployment-view-primary.jpg" width="200"></a></td></tr>
</table>

Our architecture views were documented following a lightweight [view template available here](https://github.com/pmerson/architecture-view-template). 
### ADRs

The linked ADRs below record the main architecture decisions regarding the proposed design, including their context and rationale.

- ADR 001 - [Microservice style](ADRs/ADR001-microservice-style.md)
- ADR 002 - [Payment gateway](ADRs/ADR002-payment-gateway.md)
- ADR 003 - [BFF pattern](ADRs/ADR003-bff-pattern.md)
- ADR 004 - [Wrapper pattern](ADRs/ADR004-wrapper-pattern.md)
- ADR 005 - [CQRS pattern](ADRs/ADR005-cqrs-pattern.md)
- ADR 006 - [AWS as the cloud provider](ADRs/ADR006-aws-as-cloud-provider.md)

<sub>***Note***: we used [this ADR template](https://github.com/pmerson/ADR-template/blob/master/ADR-template.md). It is slightly 
different from the template presented by Neal during the first Kata session. 
The justification is in the [README file of the ADR template repo](https://github.com/pmerson/ADR-template/blob/master/README.md#why-this-template).</sub>

--------------------------

### Backlog

Pending design activities for a hypothetical future sprint. :^)
- Better record the quality attribute requirements (aka non-functional requirements). Requires talking to Kwaku and 
other Farmacy Food stakeholders.  
- Add information in the AWS deployment architecture related to:
    - containerization and pod configuration
    - security settings
    - log consolidation
    - monitoring and tracing
- Create architecture detailing the domain model at the tactical level. Examples of information in such views:
    - entities and VOs that form aggregates (or equivalent if not using DDD modeling)
    - domain events and event hierarchies  
- Write ADR for using an event-driven architecture for order processing.
- Add the description of components that are missing in the element catalogs of the architecture views.

--------------------------

## *About the team Name*

*Miyagi's Little Forests is certainly an unusual name for a dev team. The name has both a pop culture and an academic reference:* 
- Mr. Miyagi is the shy Karate master in the 1984 "The Karate Kid" film. In the movie, which inspired a generation of then teenagers including 
the members of this team, Mr. Miyagi teaches the young Daniel-san the ancient art of Karate. The teaching of this martial art is anchored on Katas. 
Hence the nuanced connection to our architecture challenge.
- In a seminal 1976 [paper](https://www.ics.uci.edu/~andre/ics223w2006/deremerkron.pdf), Frank DeRemer and Hans Kron described 
like this the concern that 15 years later would drive the advent of the *software architecture* field: "However, current 
languages discourage the accurate recording of the overall solution structure; they force us to write programs in which 
we are so preoccupied with the trees that we lose sight of the forest, as do the readers of our programs!" For long, we 
have used the ability to see the forest and not only the trees as a metaphor for thinking the software architecture. 
- In The Karate Kid, Miyagi and Daniel-san form a team and open a store called *Miyagi's Little Trees*. So, paying 
homage to the movie and embracing the architecture metaphor, we are team **Miyagi's Little Forests**.

![Miyagi and Daniel-san](https://raw.githubusercontent.com/miyagis-forests/farmacy-food-kata/main/images/Miyagi-and-Daniel-san.jpg)

[miro-board-link]: https://miro.com/welcomeonboard/L3HbNmvEEfq2TEDaqee9xYJsYeqLm2XCxJMAG5hFZKNZkAVcBroNgxZvDVbRchCH

farmacy-food-kata

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

farmacy-food-kata

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README