This package adds a basic configuration to precache content using service worker with google workbox. Furthermore, it will add a "Add to homescreen" for your devices who are supporting it.
composer require diu/neos-pwa
Copy the following files to your site package and change the values to your need:
Settings.Workbox.yamlFor all configuration options see: https://developers.google.com/web/tools/workbox
Add all icons for the manifest, an example is in the
Settings.Manfiest.yaml and set name, colors ...
For the workbox setting, it is usually enough to adapt only the globPattern to your needs. We recommend to only include files from your package, don't add any Neos static files.
All necessary configurations are added to the
Exclude in your .gitignore
/Web/workbox-* as they should be automatically generated
while your CI/CD process and is versioned by workbox-cli.
./flow pwa:create or
This will create/update the workbox-config.json in your project root.
We recommend to use DDEV as you need a valid https connection, but it should also work with
http://localhost for development.
- make sure you have installed the package
npm add workbox-cli && npx workbox generateSW(instead of npm you can also use
yarn add workbox-cli)
Workbox needs your paths to static resources. Therefore, you have to provide a complete "build" environment.
We suggest to add a new FLOW_CONTEXT like
Development\Workbox\Settings.db.yaml where you add a setting for
an in-memory sqlite database:
Neos: Flow: persistence: backendOptions: driver: 'pdo_sqlite' path: ':memory:' username: NULL password: NULL doctrine: cacheImplementation: NULL dbname: 'flow_functional_testing'
Add these build steps:
./flow resource:publish --collection staticas workbox needs the static files while building the service worker in next step
npm add workbox-cli && npx workbox-cli generateSWThis will generate your service worker, based on the workbox-config.js in your
(instead of npm you can also use
yarn add workbox-cli)
- Autogenerate all favicon/icons based on Manifest.yaml and add them to the header
This Neos plugin is kindly sponsored by DI Unternehmer - Digitalagentur GmbH