Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit e05171f

Browse files
committedJan 10, 2025
🏗️(docs) init architecture documentation
1 parent 60dbf6c commit e05171f

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed
 

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Impress is built on top of [Django Rest Framework](https://www.django-rest-frame
1313

1414
## Getting started
1515

16+
### Architecture
17+
18+
Have a look at the [architecture](./docs/architecture.md) to get an overview of the project.
19+
1620
### Prerequisite
1721

1822
Make sure you have a recent version of Docker and [Docker

‎docs/architecture.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Architecture
2+
3+
### Global system architecture
4+
5+
```mermaid
6+
flowchart TD
7+
User -- HTTP --> Front("Frontend (NextJS SPA)")
8+
Front -- REST API --> Back("Backend (Django)")
9+
Front <-- WebSocket --> Yserver("Microservice Yjs (Express)")
10+
Front -- OIDC --> Back -- OIDC ---> Keycloak
11+
Back -- REST API --> Yserver
12+
Back --> DB("Database (PostgreSQL)")
13+
Back <--> Celery --> DB
14+
Back ----> S3("Minio (S3)")
15+
Keycloak -- OIDC --> ProConnect
16+
```

0 commit comments

Comments
 (0)
Please sign in to comment.