Skip to content
This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Commit

Permalink
Docs: Add reference to windows-build-tools
Browse files Browse the repository at this point in the history
Add reference to `windows-build-tools` so Windows users know they need a tool chain to compile binary packages.
  • Loading branch information
molant authored May 17, 2018
1 parent e176e17 commit 223eec7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This is a tutorial and demo for web push notifications that work in modern web b

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:
Expand Down Expand Up @@ -47,4 +49,4 @@ Alternatively, you can modify `configured-web-push.js` and `db/db.js` and set th
const databaseConnectionURI = process.env.DATABASE_CONNECTION_URI || '';
const vapidPublicKey = process.env.VAPID_PUBLIC_KEY || '';
const vapidPrivateKey = process.env.VAPID_PRIVATE_KEY || '';
```
```

0 comments on commit 223eec7

Please sign in to comment.