feat: basic PWA with icon (#18)

* feat: basic PWA with icon * changes * dev pwa enablement * rename manifest * set PWA start url * set theme color * trigger --------- Co-authored-by: Dennis Trümper <[email protected]>
dennistruemper · Jul 26, 2023 · 09359e1 · 09359e1
1 parent ecfbd40
commit 09359e1
Show file tree

Hide file tree

Showing 12 changed files with 100 additions and 1 deletion.
diff --git a/src/app.html b/src/app.html
@@ -2,7 +2,9 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
-		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
+		<link rel="icon" href="%sveltekit.assets%/favicon.ico" />
+		<link rel="manifest" href="manifest.json" />
+		<meta name="theme-color" content="##d946ef" />
 		<meta name="viewport" content="width=device-width" />
 		%sveltekit.head%
 	</head>

diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
@@ -1,11 +1,16 @@
 <script lang="ts">
+	import { dev } from '$app/environment';
 	import { Toaster } from 'svelte-french-toast';
 	import '../app.css';
 	import SidebarContent from '../components/sidebar/sidebarContent.svelte';
 	import TopBar from '../components/sidebar/topBar.svelte';
 	import { sidebarStore } from '../stores/sidebarStore';
 	import Cross from '../svg/cross.svelte';
 	import { backgroundBlur, itemBackground } from '../theme';
+
+	navigator.serviceWorker.register('/service-worker.js', {
+		type: dev ? 'module' : 'classic'
+	});
 </script>
 
 <div class=" min-h-screen">

diff --git a/src/service-worker.ts b/src/service-worker.ts
@@ -0,0 +1,80 @@
+/// <reference lib="webworker" />
+
+import { build, files, version } from '$service-worker';
+
+const worker = self as unknown as ServiceWorkerGlobalScope;
+const FILES = `cache${version}`;
+
+// `build` is an array of all the files generated by the bundler,
+// `files` is an array of everything in the `static` directory
+const to_cache = build.concat(files);
+const staticAssets = new Set(to_cache);
+
+worker.addEventListener('install', (event) => {
+	event.waitUntil(
+		caches
+			.open(FILES)
+			.then((cache) => cache.addAll(to_cache))
+			.then(() => {
+				worker.skipWaiting();
+			})
+	);
+});
+
+worker.addEventListener('activate', (event) => {
+	event.waitUntil(
+		caches.keys().then(async (keys) => {
+			// delete old caches
+			for (const key of keys) {
+				if (key !== FILES) await caches.delete(key);
+			}
+
+			worker.clients.claim();
+		})
+	);
+});
+
+/**
+ * Fetch the asset from the network and store it in the cache.
+ * Fall back to the cache if the user is offline.
+ */
+async function fetchAndCache(request: Request) {
+	const cache = await caches.open(`offline${version}`);
+
+	try {
+		const response = await fetch(request);
+		cache.put(request, response.clone());
+		return response;
+	} catch (err) {
+		const response = await cache.match(request);
+		if (response) return response;
+
+		throw err;
+	}
+}
+
+worker.addEventListener('fetch', (event) => {
+	if (event.request.method !== 'GET' || event.request.headers.has('range')) return;
+
+	const url = new URL(event.request.url);
+
+	// don't try to handle e.g. data: URIs
+	const isHttp = url.protocol.startsWith('http');
+	const isDevServerRequest =
+		url.hostname === self.location.hostname && url.port !== self.location.port;
+	const isStaticAsset = url.host === self.location.host && staticAssets.has(url.pathname);
+	const skipBecauseUncached = event.request.cache === 'only-if-cached' && !isStaticAsset;
+
+	if (isHttp && !isDevServerRequest && !skipBecauseUncached) {
+		event.respondWith(
+			(async () => {
+				// always serve static files and bundler-generated assets from cache.
+				// if your application has other URLs with data that will never change,
+				// set this variable to true for them and they will only be fetched once.
+				const cachedAsset = isStaticAsset && (await caches.match(event.request));
+
+				return cachedAsset || fetchAndCache(event.request);
+			})()
+		);
+	}
+});
diff --git a/static/android-chrome-192x192.png b/static/android-chrome-192x192.png
diff --git a/static/android-chrome-512x512.png b/static/android-chrome-512x512.png
diff --git a/static/apple-touch-icon.png b/static/apple-touch-icon.png
diff --git a/static/favicon-16x16.png b/static/favicon-16x16.png
diff --git a/static/favicon-32x32.png b/static/favicon-32x32.png
diff --git a/static/favicon.ico b/static/favicon.ico
diff --git a/static/favicon.png b/static/favicon.png
diff --git a/static/manifest.json b/static/manifest.json
@@ -0,0 +1,12 @@
+{
+	"name": "Lists Pink",
+	"start_url": "/",
+	"short_name": "lists pink",
+	"icons": [
+		{ "src": "/android-chrome-192x192.png", "sizes": "192x192", "type": "image/png" },
+		{ "src": "/android-chrome-512x512.png", "sizes": "512x512", "type": "image/png" }
+	],
+	"theme_color": "##d946ef",
+	"background_color": "#f0abfc",
+	"display": "standalone"
+}
diff --git a/static/ms-application.png b/static/ms-application.png