https://github.com/MicrosoftEdge/pushnotifications-demo

Demo for cross browsers push notifications with server side code
https://github.com/MicrosoftEdge/pushnotifications-demo

Last synced: 3 months ago
JSON representation

Demo for cross browsers push notifications with server side code

• Host: GitHub
• URL: https://github.com/MicrosoftEdge/pushnotifications-demo
• Owner: MicrosoftEdge
• License: apache-2.0
• Created: 2018-03-21T22:03:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T17:46:08.000Z (over 1 year ago)
• Last Synced: 2024-07-18T12:16:10.111Z (4 months ago)
• Language: JavaScript
• Size: 6.86 MB
• Stars: 120
• Watchers: 10
• Forks: 28
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Web Push Notifications Tutorial

This is a tutorial and demo for web push notifications that work in modern web browsers.

## How to use

First, install all Node.js dependencies via `npm install`.

**Note**: You will need the necessary tools to compile binaries for node. If you are on a Windows platform the easiest way is to use the [`windows-build-tools`](https://npmjs.com/package/windows-build-tools) package. 

This demo requires access to a mongodb instance for storing push subscription info to send push updates at some other point in time. It also requires specifying a public and private key for identifying your server to the push service's server. These keys, known as VAPID public/private keys, can be generated and printed to the console when first executing the site. The site can be executed by running `node index.js` which will start a server on port `4000`. You'll need to populate those keys as environment variables and execute `node index.js` again to ensure that push messages can be configured from your server.

If you are using VS Code you can set the environment variables mentioned above in your `launch.json` file as follows:

```js

{

    "version": "0.2.0",

    "configurations": [

        {

            "type": "node",

            "request": "launch",

            "name": "Launch demo",

            "program": "${workspaceFolder}/index.js",

            "env": {

                "DATABASE_CONNECTION_URI": "YOUR CONNECTION STRING",

                "VAPID_PUBLIC_KEY": "YOUR PUBLIC KEY",

                "VAPID_PRIVATE_KEY": "YOUR PRIVATE KEY",

            }

        },

        {

            "type": "node",

            "request": "launch",

            "name": "Job",

            "program": "${workspaceFolder}/App_data/jobs/triggered/notify/index.js",

            "cwd": "${workspaceFolder}/App_data/jobs/triggered/notify",

            "env": {

                "DATABASE_CONNECTION_URI": "YOUR CONNECTION STRING",

                "VAPID_PUBLIC_KEY": "YOUR PUBLIC KEY",

                "VAPID_PRIVATE_KEY": "YOUR PRIVATE KEY",

            }

        }

    ]

}

```

Alternatively, you can modify `configured-web-push.js` and `db/db.js` and set the values there explicitly:

```js

const databaseConnectionURI = process.env.DATABASE_CONNECTION_URI || '';

const vapidPublicKey = process.env.VAPID_PUBLIC_KEY || '';

const vapidPrivateKey = process.env.VAPID_PRIVATE_KEY || '';

```