Skip to content

🏗️(docs) init architecture documentation #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2025

Conversation

olaurendeau
Copy link
Contributor

@olaurendeau olaurendeau commented Jan 6, 2025

Purpose

Provide a better understanding of how doc was built and the current status of the architecture

Screenshot 2025-01-13 at 09 44 25

@olaurendeau olaurendeau changed the title (docs) init architecture documentation 🏗️(docs) init architecture documentation Jan 6, 2025
@AntoLC
Copy link
Collaborator

AntoLC commented Jan 6, 2025

Nice ! Yes it is almost that !
Maybe we can do it in Mermaid wdyt ?

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
Loading

@olaurendeau
Copy link
Contributor Author

@AntoLC AntoLC requested review from sampaccoud and AntoLC January 7, 2025 10:04
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About the ADR, it is a nice, maybe in another PR, we need a bit of time to work on it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I've updated the PR with your corrections and removed the ADR part

@AntoLC AntoLC added the documentation Improvements or additions to documentation label Jan 7, 2025
@AntoLC AntoLC force-pushed the doc/architecture branch from 47ac554 to 39fe1c4 Compare April 10, 2025 12:20
@AntoLC AntoLC requested review from AntoLC and lunika and removed request for sampaccoud April 10, 2025 12:21
Copy link
Collaborator

@AntoLC AntoLC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you for this contribution.

@AntoLC AntoLC enabled auto-merge (rebase) April 10, 2025 12:24
@AntoLC AntoLC force-pushed the doc/architecture branch from 39fe1c4 to 94ef215 Compare April 10, 2025 12:25
@AntoLC AntoLC disabled auto-merge April 10, 2025 12:28
- Add docs about architecture
- Add ADR about the CRDT choice
@AntoLC AntoLC force-pushed the doc/architecture branch from 94ef215 to 46d32d8 Compare April 10, 2025 12:31
@AntoLC AntoLC enabled auto-merge (rebase) April 10, 2025 12:32
@AntoLC AntoLC merged commit ad11b7f into suitenumerique:main Apr 10, 2025
23 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants