feat: logo and pwa

compsci-adl · Oct 4, 2024 · abcf658 · abcf658
1 parent 60d091a
commit abcf658
Show file tree

Hide file tree

Showing 13 changed files with 5,453 additions and 2,537 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # My Timetable
 
-Timetable planner for University of Adelaide students
+A drag-and-drop timetable planner for the University of Adelaide students.
 
 ## Development
 

diff --git a/index.html b/index.html
@@ -2,9 +2,16 @@
 <html lang="en">
 	<head>
 		<meta charset="UTF-8" />
-		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
 		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
 		<title>MyTimetable</title>
+		<meta
+			name="description"
+			content="A drag-and-drop timetable planner for the University of Adelaide students."
+		/>
+		<link rel="icon" href="/favicon.ico" sizes="48x48" />
+		<link rel="icon" href="/favicon.svg" sizes="any" type="image/svg+xml" />
+		<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
+		<meta name="theme-color" content="#FFFFFF" />
 		<script
 			defer
 			src="https://umami.csclub.org.au/script.js"

diff --git a/package.json b/package.json
@@ -56,6 +56,7 @@
 		"typescript": "^5.2.2",
 		"typescript-eslint": "^8.6.0",
 		"vite": "^5.3.1",
+		"vite-plugin-pwa": "^0.20.5",
 		"vitest": "^2.1.1"
 	},
 	"lint-staged": {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/public/apple-touch-icon.png b/public/apple-touch-icon.png
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/favicon.svg b/public/favicon.svg
diff --git a/public/pwa-192x192.png b/public/pwa-192x192.png
diff --git a/public/pwa-512x512.png b/public/pwa-512x512.png
diff --git a/public/pwa-maskable-192x192.png b/public/pwa-maskable-192x192.png
diff --git a/public/pwa-maskable-512x512.png b/public/pwa-maskable-512x512.png
diff --git a/public/robots.txt b/public/robots.txt
@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /
diff --git a/vite.config.ts b/vite.config.ts
@@ -1,9 +1,51 @@
 import react from '@vitejs/plugin-react';
+import { VitePWA } from 'vite-plugin-pwa';
 import { defineConfig } from 'vitest/config';
 
 // https://vitejs.dev/config/
 export default defineConfig({
-	plugins: [react()],
+	plugins: [
+		react(),
+		VitePWA({
+			registerType: 'autoUpdate',
+			includeAssets: ['favicon.ico', 'apple-touch-icon.png', 'favicon.svg'],
+			manifest: {
+				name: 'MyTimetable',
+				short_name: 'MyTimetable',
+				description:
+					'A drag-and-drop timetable planner for the University of Adelaide students.',
+				display: 'standalone',
+				background_color: '#FFFFFF',
+				theme_color: '#FFFFFF',
+				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-192x192.png',
+						sizes: '192x192',
+						type: 'image/png',
+						purpose: 'maskable',
+					},
+					{
+						src: 'pwa-maskable-512x512.png',
+						sizes: '512x512',
+						type: 'image/png',
+						purpose: 'maskable',
+					},
+				],
+			},
+		}),
+	],
 	test: {
 		globals: true,
 		env: { VITE_YEAR: '2024' },