Added READMEs for modules
This commit is contained in:
11
account-parent/README.md
Normal file
11
account-parent/README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Account Microservice
|
||||
|
||||
This is the parent project that contains modules of a microservice deployment for the _Account_ domain context. The two modules contained in this project are separated into separate deployment artifacts, one for synchronous HTTP-based interactions and one for asynchronous AMQP-based messaging.
|
||||
|
||||
## Account Web
|
||||
|
||||
The `account-web` module is a web application that produces a REST API that can be used by consumers to interact with and manage domain objects in the `Account` context. _Domain Events_ can be triggered directly over HTTP, and will also be produced in the response to actions that alter the state of the `Account` object. This web service also provides built-in hypermedia support for looking up the event logs on an aggregate domain object.
|
||||
|
||||
## Account Worker
|
||||
|
||||
The `account-worker` module is a event stream processing application that listens for `Account` domain events as AMQP messages. The domain events that are generated by the `account-web` application are processed in this module. The worker is responsible for durable transaction processing for work flows that are required to coordinate asynchronously with applications residing in other domain contexts. The worker is also responsible for automatically remediating state changes in a distributed transactions that encountered a partial failure. The most important goal of the worker module is to keep the state of the system consistent through automated means — to guarantee eventual consistency.
|
||||
3
account-parent/account-web/README.md
Normal file
3
account-parent/account-web/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Account Microservice: Web Role
|
||||
|
||||
The `account-web` module is a web application that produces a REST API that can be used by consumers to interact with and manage domain objects in the `Account` context. _Domain Events_ can be triggered directly over HTTP, and will also be produced in the response to actions that alter the state of the `Account` object. This web service also provides built-in hypermedia support for looking up the event logs on an aggregate domain object.
|
||||
3
account-parent/account-worker/README.md
Normal file
3
account-parent/account-worker/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Account Microservice: Worker
|
||||
|
||||
The `account-worker` module is a event stream processing application that listens for `Account` domain events as AMQP messages. The domain events that are generated by the `account-web` application are processed in this module. The worker is responsible for durable transaction processing for work flows that are required to coordinate asynchronously with applications residing in other domain contexts. The worker is also responsible for automatically remediating state changes in a distributed transactions that encountered a partial failure. The most important goal of the worker module is to keep the state of the system consistent through automated means — to guarantee eventual consistency.
|
||||
3
inventory-parent/README.md
Normal file
3
inventory-parent/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Inventory Microservice
|
||||
|
||||
This is the parent project that contains the modules of a microservice for the _Inventory_ domain context.
|
||||
3
invoice-parent/README.md
Normal file
3
invoice-parent/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Order Microservice
|
||||
|
||||
This is the parent project that contains the modules of a microservice for the _Order_ domain context.
|
||||
3
user-parent/README.md
Normal file
3
user-parent/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# User Microservice
|
||||
|
||||
This is the parent project that contains the modules of a microservice for the _User_ domain context.
|
||||
3
warehouse-parent/README.md
Normal file
3
warehouse-parent/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Warehouse Microservice
|
||||
|
||||
This is the parent project that contains the modules of a microservice for the _Warehouse_ domain context.
|
||||
Reference in New Issue
Block a user