# emilk/eframe_template architecture

> Architecture diagram of the GitHub repository emilk/eframe_template, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/emilk/eframe_template
- Repository: https://github.com/emilk/eframe_template

## Overview

This is a starter GUI application template: a user launches it natively or opens its web version, then interacts with a small egui app. The app restores and saves serialized state through eframe storage; the web version also supports offline caching through its service worker. The README documents native and web use, persistence, and PWA behavior. Runtime links are grounded in the sampled Rust sources or README; web page and service-worker details are documented but their implementation was not sampled.

Main entry points: [`src/app.rs`](https://github.com/emilk/eframe_template/blob/main/src/app.rs) (Template app), [`src/main.rs`](https://github.com/emilk/eframe_template/blob/main/src/main.rs) (Native entry), [`assets/sw.js`](https://github.com/emilk/eframe_template/blob/main/assets/sw.js) (Service worker), [`index.html`](https://github.com/emilk/eframe_template/blob/main/index.html) (Web page)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_launch["App launch"]
  node_native_entry["Native entry<br/>[main.rs]"]
  node_web_entry["Web entry<br/>[main.rs]"]
end

subgraph group_gui["GUI app"]
  node_app["Template app<br/>[app.rs]"]
  node_app_state["App state<br/>[app.rs]"]
  node_app_view["App UI<br/>[app.rs]"]
end

subgraph group_web["Web runtime"]
  node_page["Web page<br/>[index.html]"]
  node_service_worker["Service worker<br/>[sw.js]"]
  node_web_assets["Web manifest<br/>[manifest.json]"]
end

node_user(("User"))
node_native_runtime["Native runtime"]
node_browser["Browser"]
node_storage[("Eframe storage")]

node_user -->|"launches"| node_native_entry
node_native_entry -->|"starts"| node_native_runtime
node_native_entry -->|"constructs"| node_app
node_user -->|"opens"| node_browser
node_browser -->|"loads"| node_page
node_page -.->|"hosts"| node_web_entry
node_web_entry -->|"starts in"| node_browser
node_web_entry -->|"constructs"| node_app
node_app -->|"restores and saves"| node_app_state
node_app -->|"reads and writes"| node_storage
node_app -->|"renders"| node_app_view
node_service_worker -.->|"caches"| node_web_assets
node_service_worker -.->|"enables offline use"| node_browser

click node_native_entry "https://github.com/emilk/eframe_template/blob/main/src/main.rs"
click node_web_entry "https://github.com/emilk/eframe_template/blob/main/src/main.rs"
click node_app "https://github.com/emilk/eframe_template/blob/main/src/app.rs"
click node_app_state "https://github.com/emilk/eframe_template/blob/main/src/app.rs"
click node_app_view "https://github.com/emilk/eframe_template/blob/main/src/app.rs"
click node_page "https://github.com/emilk/eframe_template/blob/main/index.html"
click node_service_worker "https://github.com/emilk/eframe_template/blob/main/assets/sw.js"
click node_web_assets "https://github.com/emilk/eframe_template/blob/main/assets/manifest.json"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_native_entry,node_web_entry,node_user,node_browser toneBlue
class node_app,node_app_state,node_app_view,node_storage toneAmber
class node_page,node_service_worker,node_web_assets toneMint
class node_native_runtime toneIndigo
```

## Components

### App launch

- [Native entry](https://github.com/emilk/eframe_template/blob/main/src/main.rs): `src/main.rs`
- [Web entry](https://github.com/emilk/eframe_template/blob/main/src/main.rs): `src/main.rs`

### GUI app

- [Template app](https://github.com/emilk/eframe_template/blob/main/src/app.rs): `src/app.rs`
- [App state](https://github.com/emilk/eframe_template/blob/main/src/app.rs): `src/app.rs`
- [App UI](https://github.com/emilk/eframe_template/blob/main/src/app.rs): `src/app.rs`

### Web runtime

- [Web page](https://github.com/emilk/eframe_template/blob/main/index.html): `index.html`
- [Service worker](https://github.com/emilk/eframe_template/blob/main/assets/sw.js): `assets/sw.js`
- [Web manifest](https://github.com/emilk/eframe_template/blob/main/assets/manifest.json): `assets/manifest.json`

### Other components

- **User**
- **Native runtime**
- **Browser**
- **Eframe storage**

## Connections

- User → Native entry: launches (evidence: `README.md`)
- Native entry → Native runtime: starts (evidence: `src/main.rs`)
- Native entry → Template app: constructs (evidence: `src/main.rs`)
- User → Browser: opens (evidence: `README.md`)
- Browser → Web page: loads (evidence: `README.md`)
- Web page → Web entry: hosts
- Web entry → Browser: starts in (evidence: `src/main.rs`)
- Web entry → Template app: constructs (evidence: `src/main.rs`)
- Template app → App state: restores and saves (evidence: `src/app.rs`)
- Template app → Eframe storage: reads and writes (evidence: `src/app.rs`)
- Template app → App UI: renders (evidence: `src/app.rs`)
- Service worker → Web manifest: caches (evidence: `README.md`)
- Service worker → Browser: enables offline use (evidence: `README.md`)
