Skip to content

Drop the jargon and emoji from the app-modes doc #446

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.

Sign up for GitHub

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
PianoNic merged 1 commit into from
Aug 12, 2026
Merged

Drop the jargon and emoji from the app-modes doc #446

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/architecture-modes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# App modes: Account vs Private (secure)

Schuly runs in one of two modes, chosen at the gate. Both read the same
operator-provided school systems and the same backend-served catalog; the
difference is **who authenticates** and **where the data rests**. The app is
provider-agnostic - concrete systems are catalog data, never hardcoded.
Schuly runs in one of two modes, chosen at the gate. Both read the same school
systems from the same backend catalog; the difference is **who signs the user in**
and **where the data ends up**. No school system is hardcoded in the app - every one
of them comes from the catalog.

```mermaid
flowchart TB
Expand All @@ -13,7 +13,7 @@ flowchart TB
Gate -->|"Account"| Login
Gate -->|"Private (no login)"| Catalog

subgraph ACCOUNT["🔐 Account mode - Schuly login"]
subgraph ACCOUNT["Account mode - Schuly login"]
direction TB
Login["OIDC login<br/>(Keycloak)"]
ApiClient["ApiClient<br/>Bearer token + auto-refresh"]
Expand All @@ -25,7 +25,7 @@ flowchart TB
Sync -->|"stores"| DB
end

subgraph PRIVATE["🕶️ Private / secure mode - NO login, NO OIDC"]
subgraph PRIVATE["Private / secure mode - NO login, NO OIDC"]
direction TB
Catalog["SchoolSystemsService<br/>clean Dio (no auth interceptor)"]
AnonCat[("GET /api/app/school-systems<br/>[AllowAnonymous]")]
Expand Down Expand Up @@ -59,7 +59,7 @@ flowchart TB
Stateless -->|"live, nothing stored"| ScrapeProvider
```

| | 🔐 Account mode | 🕶️ Private / secure mode |
| | Account mode | Private / secure mode |
| ------------------- | ------------------------------ | ------------------------------------------------- |
| Auth to Schuly | OIDC (Keycloak) bearer | **none** |
| HTTP client | `ApiClient` (auth interceptor) | clean `Dio`, anonymous endpoints only |
Expand Down
Loading