Skip to content

Add Progressive Web App support #281

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

Open
koensayr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Progressive Web App support #281

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions myviews/debug.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@

<title>Posterr Debug Page</title>
<link rel="shortcut icon" type="image/png" href="<%=baseUrl%>/favicons/favicon.ico"/>
<link rel="manifest" href="<%=baseUrl%>/site.webmanifest">
<meta name="theme-color" content="#000000">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="Posterr">
<link rel="apple-touch-icon" href="<%=baseUrl%>/favicons/apple-touch-icon.png">
</head>

<body>
Expand Down Expand Up @@ -85,5 +91,6 @@ See logs for results
<li><%= k %>: <span class="settings"><%= keyVal %></span></li>
<% } %>
</ul>
<script src="<%=baseUrl%>/js/pwa-register.js" defer data-base-url="<%=baseUrl%>"></script>
</body>
</html>
3 changes: 2 additions & 1 deletion myviews/footer.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
<script src="<%=baseUrl%>/js/pwa-register.js" defer data-base-url="<%=baseUrl%>"></script>
</body>
</html>
</html>
6 changes: 6 additions & 0 deletions myviews/header.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,11 @@

<title>Posterr</title>
<link rel="shortcut icon" type="image/png" href="<%=baseUrl%>/favicons/favicon.ico"/>
<link rel="manifest" href="<%=baseUrl%>/site.webmanifest">
<meta name="theme-color" content="#000000">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="Posterr">
<link rel="apple-touch-icon" href="<%=baseUrl%>/favicons/apple-touch-icon.png">
</head>
<body>
7 changes: 7 additions & 0 deletions myviews/logon.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@

<title>Posterr - Settings Login</title>
<link rel="shortcut icon" type="image/png" href="<%=baseUrl%>/favicons/favicon.ico" />
<link rel="manifest" href="<%=baseUrl%>/site.webmanifest">
<meta name="theme-color" content="#000000">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="Posterr">
<link rel="apple-touch-icon" href="<%=baseUrl%>/favicons/apple-touch-icon.png">
<style>
div {
margin-left: 70px;
Expand Down Expand Up @@ -72,6 +78,7 @@ color: whitesmoke;
var pwd = document.getElementById("password");
pwd.focus();
</script>
<script src="<%=baseUrl%>/js/pwa-register.js" defer data-base-url="<%=baseUrl%>"></script>
</body>

</html>
10 changes: 8 additions & 2 deletions myviews/settings.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@

<title>Posterr - Settings</title>
<link rel="shortcut icon" type="image/png" href="<%=baseUrl%>/favicons/favicon.ico" />
<link rel="manifest" href="<%=baseUrl%>/site.webmanifest">
<meta name="theme-color" content="#000000">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="Posterr">
<link rel="apple-touch-icon" href="<%=baseUrl%>/favicons/apple-touch-icon.png">
</head>

<body>
Expand Down Expand Up @@ -1188,7 +1194,7 @@

</div>


<script src="<%=baseUrl%>/js/pwa-register.js" defer data-base-url="<%=baseUrl%>"></script>
</body>

</html>
</html>
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"scripts": "public/js/*.js",
"assets": [
"public/js/*.map",
"public/service-worker.js",
"public/site.webmanifest",
"public/css/**/*",
"public/favicons/**/*",
"public/images/**/*",
Expand Down
24 changes: 24 additions & 0 deletions public/js/pwa-register.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
(function registerPosterrPwa() {
if (!("serviceWorker" in navigator)) {
return;
}

function normalizeBaseUrl(value) {
if (!value || value === "/") {
return "";
}
return value.endsWith("/") ? value.slice(0, -1) : value;
}

const currentScript =
document.currentScript || document.querySelector('script[src$="/js/pwa-register.js"]');
const baseUrl = normalizeBaseUrl(currentScript && currentScript.getAttribute("data-base-url"));
const serviceWorkerUrl = `${baseUrl}/service-worker.js`;
const scope = `${baseUrl || ""}/`;

window.addEventListener("load", function () {
navigator.serviceWorker.register(serviceWorkerUrl, { scope: scope }).catch(function () {
// Registration failures should not impact normal app usage.
});
});
})();
86 changes: 86 additions & 0 deletions public/service-worker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
const CACHE_NAME = "posterr-v1";
const STATIC_CACHE = "posterr-static-v1";

function getScopePath() {
const scopeUrl = new URL(self.registration.scope);
const scopePath = scopeUrl.pathname.replace(/\/$/, "");
return scopePath === "/" ? "" : scopePath;
}

function withScope(path) {
return `${getScopePath()}${path}`;
}

self.addEventListener("install", (event) => {
const coreAssets = [
"/",
"/css/bootstrap.min.css",
"/css/font-awesome.min.css",
"/css/styles.css",
"/js/jquery-3.3.1.slim.min.js",
"/js/bootstrap.min.js",
"/images/no-poster-available.png",
"/favicons/favicon.ico",
"/favicons/android-chrome-192x192.png",
"/favicons/android-chrome-512x512.png",
"/site.webmanifest"
].map(withScope);

event.waitUntil(
caches.open(CACHE_NAME).then((cache) => cache.addAll(coreAssets)).then(() => self.skipWaiting())
);
});

self.addEventListener("activate", (event) => {
event.waitUntil(
caches
.keys()
.then((keys) =>
Promise.all(
keys
.filter((key) => key !== CACHE_NAME && key !== STATIC_CACHE)
.map((key) => caches.delete(key))
)
)
.then(() => self.clients.claim())
);
});

self.addEventListener("fetch", (event) => {
const request = event.request;
if (request.method !== "GET") {
return;
}

const requestUrl = new URL(request.url);
if (requestUrl.origin !== self.location.origin) {
return;
}

if (request.mode === "navigate") {
event.respondWith(
fetch(request)
.then((response) => {
const responseClone = response.clone();
caches.open(CACHE_NAME).then((cache) => cache.put(request, responseClone));
return response;
})
.catch(() => caches.match(request).then((cached) => cached || caches.match(withScope("/"))))
);
return;
}

event.respondWith(
caches.match(request).then((cached) => {
const networkFetch = fetch(request)
.then((response) => {
const responseClone = response.clone();
caches.open(STATIC_CACHE).then((cache) => cache.put(request, responseClone));
return response;
})
.catch(() => cached);

return cached || networkFetch;
})
);
});
22 changes: 22 additions & 0 deletions public/site.webmanifest
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "Posterr",
"short_name": "Posterr",
"description": "A digital display for your media",
"start_url": ".",
"scope": ".",
"display": "standalone",
"background_color": "#000000",
"theme_color": "#000000",
"icons": [
{
"src": "favicons/android-chrome-192x192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "favicons/android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
]
}