Push Notifications Server

This server will create mock services that will allow you to test Push Notifications API in your local machine.

Server setup

npm run install: Setup project dependencies
npm run init: Create VAPID keys and base .env file.
Copy the private and public keys into the generated .env file. (Do not hardcode or share these credentials).
Copy public key to client/client.js in the constant VAPID_KEY
Start the server with npm run start
Open local server with npm run open-client:[your os] available options are (macos, linux, windows. You can also open the following url http://127.0.0.1:3000.

API Endpoints

/subscribe

Type: POST
Endpoint: http://127.0.0.1:3000/subscribe This is the endpoint used by clients to subscribe. Users will be prompted to authorize notifications from their site.

Payload object is built by the browser upon user consent:

{
  "endpoint": "https://random-push-service.com/some-kind-of-unique-id-1234/v2/",
  "keys": {
    "p256dh" :
"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=",
    "auth"   : "tBHItJI5svbpez7KI4CCXg=="
  }
}

/notify

Type: POST
Endpoint: http://127.0.0.1:3000/notify
Notification body:

{
  "title":"Lorem in irure officia veniam laborum",
  "body":"Qui proident labore pariatur do incididunt ex fugiat ipsum. Exercitation tempor dolor adipisicing enim qui voluptate dolore magna",
  "icon":"https://www.gstatic.com/images/icons/material/product/2x/chrome_chromium_64dp.png",
  "tag": "officia-ea-nulla-esse"
}

/

Serves client html

Push custom notification to all registered clients.

Notifications overview

Ask for consent flow: A service worker will be setup in the client upon user consent.
Display notification flow: Notification badge dismissal, click, and decision making take place on the service worker script.

Reference

Google Developers: Web Fundamentals - Web Push Notifications: Timely, Relevant, and Precise

Jose Tovar - http://tovar.co

to-var / push-notifications-server