Service worker js

README.md

@@ -8,13 +8,13 @@ composer require pixelspin/silverstripe-progressivewebapp
 ```
 
 ## Usage
-Install the module, run dev/build and fill in the settings in the siteconfig
-Create a symlink at the root of you website to vendor/pixelspin/silverstripe-progressivewebapp/service-worker.js
-Place the link to the manifest file (<link rel="manifest" href="{$BaseHref}manifest.json">) in the head of your pages and add the color meta data as well (<meta name="theme-color" content="$SiteConfig.ManifestColor">)
-Include the js (Requirements::javascript('pixelspin/silverstripe-progressivewebapp:resources/js/progressivewebapp.js');)
-
-## Todo
-- Add "add to homescreen" prompt
-- Add offline support
-- Create an you are offline page
-- Improve documentation
+- Install the module, run dev/build and fill in the settings in the siteconfig
+- Include the required js to register the service worker
+```
+Requirements::javascript('pixelspin/silverstripe-progressivewebapp:resources/js/progressivewebapp.js');
+```
+- Add the following tags to the head of your website
+```
+<meta name="theme-color" content="$SiteConfig.ManifestColor">
+<link rel="manifest" href="{$BaseHref}manifest.json">
+```

_config/config.yml

@@ -4,7 +4,8 @@ Name: progressivewebapp
 
 SilverStripe\Control\Director:
   rules:
-    'manifest.json': 'Pixelspin\ProgressiveWebApp\Controllers\ProgressiveWebAppController'
+    'manifest.json': 'Pixelspin\ProgressiveWebApp\Controllers\ManifestController'
+    'service-worker.js': 'Pixelspin\ProgressiveWebApp\Controllers\ServiceWorkerController'
     
 SilverStripe\SiteConfig\SiteConfig:
     extensions:

resources/js/progressivewebapp.js

@@ -1,3 +1,6 @@
 if ('serviceWorker' in navigator) {
-  navigator.serviceWorker.register('/service-worker.js');
+    var baseHref = (document.getElementsByTagName('base')[0] || {}).href;
+    if(baseHref){
+        navigator.serviceWorker.register(baseHref + 'service-worker.js');
+    }
 }

service-worker.js

@@ -1 +0,0 @@
-self.addEventListener('fetch', (event) => {});

src/Controllers/ManifestController.php

@@ -5,7 +5,7 @@ namespace Pixelspin\ProgressiveWebApp\Controllers;
 use SilverStripe\Control\Controller;
 use SilverStripe\SiteConfig\SiteConfig;
 
-class ProgressiveWebAppController extends Controller {
+class ManifestController extends Controller {
 
     /**
      * @var array

src/Controllers/ServiceWorkerController.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Pixelspin\ProgressiveWebApp\Controllers;
+
+use SilverStripe\Control\Controller;
+
+class ServiceWorkerController extends Controller {
+
+    /**
+     * @var array
+     */
+    private static $allowed_actions = [
+        'index'
+    ];
+
+    /**
+     * Default controller action for the service-worker.js file
+     *
+     * @return mixed
+     */
+    public function index($url) {
+        $this->getResponse()->addHeader('Content-Type', 'application/javascript; charset="utf-8"');
+        return $this->renderWith('ServiceWorker');
+    }
+
+}

templates/ServiceWorker.ss

@@ -0,0 +1 @@
+self.addEventListener('fetch', (event) => {});