Skip to content

Commit

Permalink
simplify vapid key generation docs (#72916)
Browse files Browse the repository at this point in the history
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

### What?
Simplify Vapid key generation docs

### Why?
Creating a script is tedious.
The CLI can be used across projects without needing to reference and
recreate this script.

### How?
Added instructions to install `web-push` globally and how to run it.

---------

Co-authored-by: Delba de Oliveira <[email protected]>
  • Loading branch information
philparzer and delbaoliveira authored Nov 19, 2024
1 parent f5ead56 commit 720fe35
Showing 1 changed file with 12 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -508,27 +508,26 @@ In a production environment, you would want to store the subscription in a datab
### 4. Generating VAPID Keys
To use the Web Push API, you need to generate [VAPID](https://vapidkeys.com/) keys.
To use the Web Push API, you need to generate [VAPID](https://vapidkeys.com/) keys. The simplest way is to use the web-push CLI directly:
Create a script file, e.g., `generate-vapid-keys.js`:
First, install web-push globally:
```js filename="./generate-vapid-keys.js"
const webpush = require('web-push')
const vapidKeys = webpush.generateVAPIDKeys()

console.log('Paste the following keys in your .env file:')
console.log('-------------------')
console.log('NEXT_PUBLIC_VAPID_PUBLIC_KEY=', vapidKeys.publicKey)
console.log('VAPID_PRIVATE_KEY=', vapidKeys.privateKey)
```bash filename="Terminal"
npm install -g web-push
```
Run this script with Node.js to generate your VAPID keys:
Generate the VAPID keys by running:
```bash filename="Terminal"
node generate-vapid-keys.js
web-push generate-vapid-keys
```
Copy the output and paste it into your `.env` file.
Copy the output and paste the keys into your `.env` file:
```.env
NEXT_PUBLIC_VAPID_PUBLIC_KEY=your_public_key_here
VAPID_PRIVATE_KEY=your_private_key_here
```
### 5. Creating a Service Worker
Expand Down

0 comments on commit 720fe35

Please sign in to comment.