{"id":17187180,"url":"https://github.com/domfarolino/push-notifications","last_synced_at":"2025-04-13T18:37:59.160Z","repository":{"id":71306260,"uuid":"58338060","full_name":"domfarolino/push-notifications","owner":"domfarolino","description":"Progressive Web App demonstrating push notifications with encrypted payload","archived":false,"fork":false,"pushed_at":"2025-02-06T04:39:55.000Z","size":391,"stargazers_count":6,"open_issues_count":3,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-27T09:21:25.747Z","etag":null,"topics":["encrypted-payloads","nodejs","notifications","push-notifications","web-push"],"latest_commit_sha":null,"homepage":"https://domfarolino.com/push-notifications","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/domfarolino.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-09T00:37:15.000Z","updated_at":"2025-02-06T04:39:58.000Z","dependencies_parsed_at":"2023-11-23T04:22:38.574Z","dependency_job_id":"fc3d5f62-3a93-4716-bb95-544d68021886","html_url":"https://github.com/domfarolino/push-notifications","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domfarolino%2Fpush-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domfarolino%2Fpush-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domfarolino%2Fpush-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domfarolino%2Fpush-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/domfarolino","download_url":"https://codeload.github.com/domfarolino/push-notifications/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248762539,"owners_count":21157748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["encrypted-payloads","nodejs","notifications","push-notifications","web-push"],"created_at":"2024-10-15T01:05:37.393Z","updated_at":"2025-04-13T18:37:59.134Z","avatar_url":"https://github.com/domfarolino.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# push-notifications\n\n[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/images/notify.png\"\u003e\n\u003c/p\u003e\n\nThis app demonstrates the [web-push-libs/web-push](https://github.com/web-push-libs/web-push) NodeJS\nlibrary which facilitates sending web push notifications with encrypted payloads via a custom backend.\n\n# Demo\n\nDemo the live application [here](https://domfarolino.com/push-notifications)\n\n# Getting started\n\n## Client\n\nThe client-side app is a simple static site rooted at [`docs/`](./docs). The\nreason the site lives in the `docs/` folder is because GitHub pages only allows\nyou to serve static pages from the root or `docs/` folder — custom folders like\n`frontend/` or `client/` are not supported.\n\n## Server\n\n```sh\ngit clone git@github.com:domfarolino/push-notifications.git\ncp .env.example .env # Copy environment variable structure\nnpm install\nnpm start # Run the server\n```\n\nTo run the *server* locally you must export the necessary environment variables.\nEnvironment variables should appear in the `.env` file, and below is an\nexplanation of what each variables is used for:\n\n - `PORT`: Defines the port on which the server will run.\n - `VAPID_PUBLIC_KEY`: Defines the public key generated via `node web-push generate-vapid-keys`\n - `VAPID_PRIVATE_KEY`: Defines the private key generated via `node web-push generate-vapid-keys`\n - `MONGO_URL`: Push notification credentials generated by the client are persisted in MongoDB. Use your mongo URL to save client-generated credentials.\n - `API_KEY`: Used to secure some routes local to this application, such as `/credentials`.\n\nWhen running the server locally, be sure to update `this.backendURL` in\n[`docs/js/main.js`](docs/js/main.js) to point to your local server.\n\n# Push Notification Screenshots\n\n## Chrome\n\n![chromeNotif](./chromeNotif.png)\n\n## Firefox\n\n![ffNotif](./ffNotif.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdomfarolino%2Fpush-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdomfarolino%2Fpush-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdomfarolino%2Fpush-notifications/lists"}