feat: add PWA support
This commit is contained in:
@@ -15,6 +15,7 @@ The current MVP slice includes:
|
|||||||
- disabled-by-default, serial-pinned ADB status, APK installation, package inventory, and validated app shortcuts;
|
- disabled-by-default, serial-pinned ADB status, APK installation, package inventory, and validated app shortcuts;
|
||||||
- live MG4 speed, gear, and steering-angle telemetry with a dedicated visual Car dashboard;
|
- live MG4 speed, gear, and steering-angle telemetry with a dedicated visual Car dashboard;
|
||||||
- a responsive 1920×720-oriented setup, login, and dashboard UI;
|
- a responsive 1920×720-oriented setup, login, and dashboard UI;
|
||||||
|
- an installable PWA shell with standalone landscape display and cached dashboard assets;
|
||||||
- an idempotent Raspberry Pi installer with systemd start-on-boot support;
|
- an idempotent Raspberry Pi installer with systemd start-on-boot support;
|
||||||
- atomic, dashboard-triggered Git updates with automatic verification and rollback safety;
|
- atomic, dashboard-triggered Git updates with automatic verification and rollback safety;
|
||||||
- optional dual-radio Wi-Fi failover with an always-recoverable offline car hotspot;
|
- optional dual-radio Wi-Fi failover with an always-recoverable offline car hotspot;
|
||||||
@@ -106,6 +107,8 @@ npm run dev:web
|
|||||||
|
|
||||||
Open `http://127.0.0.1:5173`. The development server proxies API requests to `http://127.0.0.1:8787`.
|
Open `http://127.0.0.1:5173`. The development server proxies API requests to `http://127.0.0.1:8787`.
|
||||||
|
|
||||||
|
The production build includes a web app manifest and service worker. PWA installation and offline shell caching require a secure browser context: HTTPS in production, or `localhost` during local use. The dashboard still requires the Pi connection for live data and authenticated actions.
|
||||||
|
|
||||||
Local development data is stored in `server/data/companion.db` and ignored by Git.
|
Local development data is stored in `server/data/companion.db` and ignored by Git.
|
||||||
|
|
||||||
## Quality gate
|
## Quality gate
|
||||||
|
|||||||
@@ -723,6 +723,42 @@ export async function buildApp(config: AppConfig): Promise<FastifyInstance> {
|
|||||||
reply.type("text/html; charset=utf-8");
|
reply.type("text/html; charset=utf-8");
|
||||||
return reply.send(createReadStream(resolve(webRoot, "index.html")));
|
return reply.send(createReadStream(resolve(webRoot, "index.html")));
|
||||||
});
|
});
|
||||||
|
const publicFiles: Record<string, { file: string; type: string; cacheControl: string }> = {
|
||||||
|
"/manifest.webmanifest": {
|
||||||
|
file: "manifest.webmanifest",
|
||||||
|
type: "application/manifest+json; charset=utf-8",
|
||||||
|
cacheControl: "no-cache"
|
||||||
|
},
|
||||||
|
"/service-worker.js": {
|
||||||
|
file: "service-worker.js",
|
||||||
|
type: "text/javascript; charset=utf-8",
|
||||||
|
cacheControl: "no-cache"
|
||||||
|
},
|
||||||
|
"/icon.svg": { file: "icon.svg", type: "image/svg+xml", cacheControl: "public, max-age=86400" },
|
||||||
|
"/pwa-192x192.png": { file: "pwa-192x192.png", type: "image/png", cacheControl: "public, max-age=86400" },
|
||||||
|
"/pwa-512x512.png": { file: "pwa-512x512.png", type: "image/png", cacheControl: "public, max-age=86400" },
|
||||||
|
"/pwa-maskable-512x512.png": {
|
||||||
|
file: "pwa-maskable-512x512.png",
|
||||||
|
type: "image/png",
|
||||||
|
cacheControl: "public, max-age=86400"
|
||||||
|
},
|
||||||
|
"/apple-touch-icon.png": {
|
||||||
|
file: "apple-touch-icon.png",
|
||||||
|
type: "image/png",
|
||||||
|
cacheControl: "public, max-age=86400"
|
||||||
|
}
|
||||||
|
};
|
||||||
|
for (const [route, asset] of Object.entries(publicFiles)) {
|
||||||
|
app.get(route, async (_request, reply) => {
|
||||||
|
const assetPath = resolve(webRoot, asset.file);
|
||||||
|
if (!existsSync(assetPath) || !statSync(assetPath).isFile()) {
|
||||||
|
return reply.code(404).send({ error: { code: "NOT_FOUND", message: "Asset not found" } });
|
||||||
|
}
|
||||||
|
reply.type(asset.type);
|
||||||
|
reply.header("Cache-Control", asset.cacheControl);
|
||||||
|
return reply.send(createReadStream(assetPath));
|
||||||
|
});
|
||||||
|
}
|
||||||
app.get<{ Params: { file: string } }>("/assets/:file", async (request, reply) => {
|
app.get<{ Params: { file: string } }>("/assets/:file", async (request, reply) => {
|
||||||
if (!/^[a-zA-Z0-9._-]+$/.test(request.params.file)) {
|
if (!/^[a-zA-Z0-9._-]+$/.test(request.params.file)) {
|
||||||
return reply.code(404).send({ error: { code: "NOT_FOUND", message: "Asset not found" } });
|
return reply.code(404).send({ error: { code: "NOT_FOUND", message: "Asset not found" } });
|
||||||
|
|||||||
@@ -5,6 +5,13 @@
|
|||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<meta name="theme-color" content="#10130f" />
|
<meta name="theme-color" content="#10130f" />
|
||||||
<meta name="color-scheme" content="dark" />
|
<meta name="color-scheme" content="dark" />
|
||||||
|
<meta name="application-name" content="Pi Car Companion" />
|
||||||
|
<meta name="apple-mobile-web-app-capable" content="yes" />
|
||||||
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
||||||
|
<meta name="apple-mobile-web-app-title" content="Pi Car" />
|
||||||
|
<link rel="manifest" href="/manifest.webmanifest" />
|
||||||
|
<link rel="icon" href="/icon.svg" type="image/svg+xml" />
|
||||||
|
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
|
||||||
<title>Pi Car Companion</title>
|
<title>Pi Car Companion</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
@@ -0,0 +1,8 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" role="img" aria-label="Pi Car Companion">
|
||||||
|
<rect width="512" height="512" fill="#10130f"/>
|
||||||
|
<circle cx="256" cy="256" r="164" fill="#171b16" stroke="#30372d" stroke-width="16"/>
|
||||||
|
<path d="M148 300a120 120 0 1 1 216 0" fill="none" stroke="#b9e769" stroke-width="30" stroke-linecap="round"/>
|
||||||
|
<path d="m256 268 73-82" fill="none" stroke="#f0f2eb" stroke-width="26" stroke-linecap="round"/>
|
||||||
|
<circle cx="256" cy="268" r="30" fill="#b9e769"/>
|
||||||
|
<path d="M173 337h166" fill="none" stroke="#f0f2eb" stroke-width="24" stroke-linecap="round"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 610 B |
@@ -0,0 +1,33 @@
|
|||||||
|
{
|
||||||
|
"id": "/",
|
||||||
|
"name": "Pi Car Companion",
|
||||||
|
"short_name": "Pi Car",
|
||||||
|
"description": "Local dashboard for your Raspberry Pi car companion.",
|
||||||
|
"start_url": "/",
|
||||||
|
"scope": "/",
|
||||||
|
"display": "standalone",
|
||||||
|
"orientation": "landscape",
|
||||||
|
"background_color": "#10130f",
|
||||||
|
"theme_color": "#10130f",
|
||||||
|
"categories": ["navigation", "utilities"],
|
||||||
|
"icons": [
|
||||||
|
{
|
||||||
|
"src": "/pwa-192x192.png",
|
||||||
|
"sizes": "192x192",
|
||||||
|
"type": "image/png",
|
||||||
|
"purpose": "any"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"src": "/pwa-512x512.png",
|
||||||
|
"sizes": "512x512",
|
||||||
|
"type": "image/png",
|
||||||
|
"purpose": "any"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"src": "/pwa-maskable-512x512.png",
|
||||||
|
"sizes": "512x512",
|
||||||
|
"type": "image/png",
|
||||||
|
"purpose": "maskable"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
@@ -0,0 +1,63 @@
|
|||||||
|
const CACHE_NAME = "pi-car-companion-v1";
|
||||||
|
const APP_SHELL = [
|
||||||
|
"/",
|
||||||
|
"/manifest.webmanifest",
|
||||||
|
"/icon.svg",
|
||||||
|
"/pwa-192x192.png",
|
||||||
|
"/pwa-512x512.png",
|
||||||
|
"/pwa-maskable-512x512.png",
|
||||||
|
"/apple-touch-icon.png"
|
||||||
|
];
|
||||||
|
|
||||||
|
self.addEventListener("install", (event) => {
|
||||||
|
event.waitUntil(caches.open(CACHE_NAME).then((cache) => cache.addAll(APP_SHELL)));
|
||||||
|
self.skipWaiting();
|
||||||
|
});
|
||||||
|
|
||||||
|
self.addEventListener("activate", (event) => {
|
||||||
|
event.waitUntil(
|
||||||
|
caches
|
||||||
|
.keys()
|
||||||
|
.then((keys) => Promise.all(keys.filter((key) => key !== CACHE_NAME).map((key) => caches.delete(key))))
|
||||||
|
.then(() => self.clients.claim())
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
self.addEventListener("fetch", (event) => {
|
||||||
|
const request = event.request;
|
||||||
|
if (request.method !== "GET") return;
|
||||||
|
|
||||||
|
const url = new URL(request.url);
|
||||||
|
if (url.origin !== self.location.origin || url.pathname.startsWith("/api/") || url.pathname === "/healthz") return;
|
||||||
|
|
||||||
|
if (request.mode === "navigate") {
|
||||||
|
event.respondWith(
|
||||||
|
fetch(request)
|
||||||
|
.then((response) => {
|
||||||
|
if (response.ok) {
|
||||||
|
const copy = response.clone();
|
||||||
|
event.waitUntil(caches.open(CACHE_NAME).then((cache) => cache.put("/", copy)));
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
})
|
||||||
|
.catch(() => caches.match("/"))
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url.pathname.startsWith("/assets/") || APP_SHELL.includes(url.pathname)) {
|
||||||
|
event.respondWith(
|
||||||
|
caches.match(request).then(
|
||||||
|
(cached) =>
|
||||||
|
cached ??
|
||||||
|
fetch(request).then((response) => {
|
||||||
|
if (response.ok) {
|
||||||
|
const copy = response.clone();
|
||||||
|
event.waitUntil(caches.open(CACHE_NAME).then((cache) => cache.put(request, copy)));
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
})
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -8,3 +8,9 @@ createRoot(document.getElementById("root")!).render(
|
|||||||
<App />
|
<App />
|
||||||
</StrictMode>
|
</StrictMode>
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if (import.meta.env.PROD && "serviceWorker" in navigator) {
|
||||||
|
window.addEventListener("load", () => {
|
||||||
|
void navigator.serviceWorker.register("/service-worker.js");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user