Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 2.29 KB

README.md

File metadata and controls

104 lines (69 loc) · 2.29 KB

Ignore my awful english!

Magento 2 PWA

Codacy Badge

This a simple module to make your site PWA.

Installation

You need modify your Nginx configuration file for the module to work.

Server configuration...

# service worker location
location ~*\/(sw|OneSignalSDKUpdaterWorker|OneSignalSDKWorker)\.js {
    alias $MAGE_ROOT/$1.js;
}

Add this in media location...

add_header 'Service-Worker-Allowed' '/';

Configurations

All the configurations are in Store > Configuration > Resultate > PWA Configs

Configure your manifest

Configure your manifest.json.

Add the tags and values...

E.g.:

Tags Values
short_name My Site
name My Site Full Name
start_ur /
background_color #FFFFFF
theme_color #FFFFFF
display standalone

You can upload your icons in the configurations, but you need save to upload the file!

All the files uploaded are listed in the configuration!

Add your tag icons...

E.g.:

SRC Type Sizes
/media/pwa/manifest/icons/default/icon-192.png image/png 192x192
/media/pwa/manifest/icons/default/icon-512.png image/png 512x512

After save, click on button to generate manifest.json

Configure your Service Worker

Add your pre cached routes...

E.g.:

Route
/
/cat1
/cat2
/cat2

Configure your cache max age...

In this field you can select 1-7 days.

Add your cache prefix...

E.g.:

my-site-prd

Add your cache suffix...

If empty, the value is the deploy version.

E.g.:

v1

Configure OneSignal

This configuration is if you wants add the OneSignal in your site.

Add your appId...

E.g.:

1234asd-asd1234-1234asd-asd1234