From bf1ee4123812a76735f3ef56e635a60708b09038 Mon Sep 17 00:00:00 2001
From: Konstantin Wohlwend <n2d4xc@gmail.com>
Date: Sat, 17 Aug 2024 14:37:55 -0700
Subject: [PATCH] Add architecture diagram

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index c9eef4c96..b59d4df4b 100644
--- a/README.md
+++ b/README.md
@@ -144,6 +144,55 @@ If you make changes to the Prisma schema, you need to run the following command
 pnpm run prisma migrate dev
 ```
 
+### Architecture diagram
+
+<details>
+```mermaid
+graph TB
+    User((User))
+    Admin((Admin))
+    subgraph “Stack Auth System”
+        Dashboard[Dashboard<br/>Next.js Application]
+        Backend[Backend Service<br/>Next.js API]
+        Database[(PostgreSQL Database)]
+        EmailService[Email Service<br/>Inbucket]
+        WebhookService[Webhook Service<br/>Svix]
+        subgraph “Shared Packages”
+            StackUI[Stack UI<br/>React Components]
+            StackShared[Stack Shared<br/>Utilities]
+            StackEmails[Stack Emails<br/>Email Templates]
+        end
+    end
+    ExternalOAuth[External OAuth Providers]
+    User --> Dashboard
+    Admin --> Dashboard
+    Dashboard --> Backend
+    Dashboard -.-> |“(To be removed)“| Database
+    Dashboard -.-> |“(To be removed)“| EmailService
+    Backend --> Database
+    Backend --> EmailService
+    Backend --> WebhookService
+    Backend --> ExternalOAuth
+    Dashboard --> StackUI
+    Dashboard --> StackShared
+    Dashboard --> StackEmails
+    Backend --> StackShared
+    Backend --> StackEmails
+    subgraph “External Services”
+        Svix[Svix]
+        WebhookService --> Svix
+    end
+    classDef container fill:#1168bd,stroke:#0b4884,color:#ffffff
+    classDef database fill:#2b78e4,stroke:#1a4d91,color:#ffffff
+    classDef external fill:#999999,stroke:#666666,color:#ffffff
+    classDef deprecated stroke-dasharray: 5 5
+    class Dashboard,Backend,EmailService,WebhookService container
+    class Database database
+    class ExternalOAuth,Svix external
+```
+Thanks to [CodeViz](https://www.codeviz.ai) for the diagram!
+</details>
+
 ## ❤️ Contributors
 
 Thanks to the amazing community who built Stack: