From f85e654ac77d81ef2f29fde8815b49b2d4ee98d6 Mon Sep 17 00:00:00 2001
From: Fabrice Lecomte <fabrice.lecomte.be@gmail.com>
Date: Tue, 15 Apr 2025 01:05:06 +0200
Subject: [PATCH] doc: create diagram

---
 README.md         | 16 +++++++--
 doc/Workflow.puml | 84 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+), 2 deletions(-)
 create mode 100644 doc/Workflow.puml

diff --git a/README.md b/README.md
index 265dec4..3fb68d4 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Installation
 To run the stack:
 
 ```shell
-docker compose -f docker\docker-compose.yaml -p event-demo up -d
+docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
 ```
 
 Api url:
@@ -56,11 +56,23 @@ What's in this demo
 The stack
 ---------
 
+Language
 - Kotlin
+
+Framwork
 - Ktor
+
+Database
 - Postgresql
+  - with Flyway
 - Redis
 - RabbitMQ
+
+Infra
 - Docker
 - Træfik
-- Flyway
\ No newline at end of file
+
+Architecture
+============
+
+[Diagram](./doc/Workflow.puml)
\ No newline at end of file
diff --git a/doc/Workflow.puml b/doc/Workflow.puml
new file mode 100644
index 0000000..6cbb402
--- /dev/null
+++ b/doc/Workflow.puml
@@ -0,0 +1,84 @@
+@startuml
+'https://plantuml.com/use-case-diagram
+
+package Legend {
+    usecase (Queries) #7693C4
+    usecase (Projections) #AB64C9
+    usecase (Events) #5FAD56
+}
+
+actor  User
+entity Query #7693C4
+
+entity Command #5FAD56
+entity Event #5FAD56
+entity Projection #AB64C9
+
+database  Postgresql
+database  Redis
+queue     RabbitMQ
+
+usecase  (Web socket adapter) #5FAD56
+usecase  (Command handler) #5FAD56
+usecase/ (Action) #5FAD56
+usecase  (Event handler) #5FAD56
+usecase  (Version builder) #5FAD56
+usecase  (Event store) #5FAD56
+usecase  (Event stream) #5FAD56
+usecase  (Event bus) #5FAD56
+usecase/ (Reaction listener) #5FAD56
+
+usecase/ (Projection builder) #AB64C9
+usecase  (Projection repository) #AB64C9
+usecase  (Projection bus) #AB64C9
+
+usecase  (Controller) #7693C4
+
+User -> Query : <<create>>
+Command <- User : <<create>>
+User ---> (Controller) : Get \nprojection
+User <-- (Controller) : Returns \nprojection
+
+(Controller) --------> (Projection repository) : Get \nprojection
+
+User -> (Web socket adapter) : Send \ncommand
+(Web socket adapter) --> (Command handler) : Send \ncommand
+(Web socket adapter) ...> User : Send notification \n(error or success)
+
+(Command handler) ..> (Web socket adapter) : Send \nnotification
+(Command handler) -> (Action) : Execute action
+(Command handler) <- (Action) : Returns \nevent builder
+(Command handler) ---> (Event handler) : Dispatch \nevent \n(send an event builder)
+(Command handler) --> Event : <<Create>>
+
+(Event handler) --> (Event store) : Publish \nevent
+(Event handler) <-- (Reaction listener) : Dispatch \n new event
+(Version builder) <- (Event handler) : build next version
+note "Acquire a lock, \nget the next event version, \nand then, build the event " as EventHandlerNote
+EventHandlerNote <-- (Event handler)
+
+(Event store) -left-> (Event stream)
+(Event store) ---> (Event bus) : Publish \nevent
+
+(Event stream) --> Postgresql : Persist \nevent
+(Event bus) -> RabbitMQ : Publish \nevent
+(Event bus) -> RabbitMQ : Subscribe \nto event
+(Event bus) <. RabbitMQ : Emit event
+
+(Reaction listener) ---> (Projection bus) : Subscribe
+(Reaction listener) <.. (Projection bus) : Emit projection
+
+(Projection bus) <- (Projection repository) : Publish \nprojection
+RabbitMQ <- (Projection bus) : Publish \nprojection
+RabbitMQ <- (Projection bus) : Subscribe \nto projection
+RabbitMQ .> (Projection bus) : Emit projection
+
+(Event bus) <---- (Projection repository) : Subscribe
+(Event bus) ..> (Projection repository) : Emit event
+
+(Projection repository) --> Redis : Persist \nprojection
+(Projection repository) <- Redis : Get \nprojection
+(Projection repository) -> (Projection builder) : Build \nprojection
+
+(Projection builder) --> Projection : <<create projection>>
+@enduml
\ No newline at end of file