🏗️(docs) init architecture documentation #536
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olaurendeau
changed the title
|
Nice ! Yes it is almost that ! graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
|
AntoLC
reviewed
Jan 7, 2025
docs/architecture.md
Outdated
Comment on lines
7
to
17
| User -- HTTP --> Front("Frontend (NextJS)") | ||
| Front -- REST API --> Back("Backend (Django)") | ||
| Front <-- WebSocket --> Yserver("Microservice Yjs (Express)") | ||
| Back <-- WebSocket --> Yserver | ||
| Back -- REST API --> Yserver | ||
| Back --> DB("Database (PostgreSQL)") | ||
| Back <--> Celery --> DB | ||
| Front ----> S3 | ||
| Front -- OIDC ---> Keycloak | ||
| Keycloak -- OIDC --> ProConnect | ||
| Crowdin |
There was a problem hiding this comment.
The archi is more like that.
Suggested change
| User -- HTTP --> Front("Frontend (NextJS)") | |
| Front -- REST API --> Back("Backend (Django)") | |
| Front <-- WebSocket --> Yserver("Microservice Yjs (Express)") | |
| Back <-- WebSocket --> Yserver | |
| Back -- REST API --> Yserver | |
| Back --> DB("Database (PostgreSQL)") | |
| Back <--> Celery --> DB | |
| Front ----> S3 | |
| Front -- OIDC ---> Keycloak | |
| Keycloak -- OIDC --> ProConnect | |
| Crowdin | |
| 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 |
There was a problem hiding this comment.
About the ADR, it is a nice, maybe in another PR, we need a bit of time to work on it.
There was a problem hiding this comment.
Alright, I've updated the PR with your corrections and removed the ADR part
olaurendeau
force-pushed
the
doc/architecture
branch
from
61fb45b to
e05171f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Provide a better understanding of how doc was built and the current status of the architecture