🏗️(docs) init architecture documentation

suitenumerique · Jan 10, 2025 · e05171f · e05171f
1 parent 60dbf6c
commit e05171f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,10 @@ Impress is built on top of [Django Rest Framework](https://www.django-rest-frame
 
 ## Getting started
 
+### Architecture
+
+Have a look at the [architecture](./docs/architecture.md) to get an overview of the project.
+
 ### Prerequisite
 
 Make sure you have a recent version of Docker and [Docker

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,16 @@
+## Architecture
+
+### Global system architecture
+
+```mermaid
+flowchart TD
+    User -- HTTP --> Front("Frontend (NextJS SPA)")
+    Front -- REST API --> Back("Backend (Django)")
+    Front <-- WebSocket --> Yserver("Microservice Yjs (Express)")
+    Front -- OIDC --> Back -- OIDC ---> Keycloak
+    Back -- REST API --> Yserver
+    Back --> DB("Database (PostgreSQL)")
+    Back <--> Celery --> DB
+    Back ----> S3("Minio (S3)")
+    Keycloak -- OIDC --> ProConnect
+```