{"id":19224751,"url":"https://github.com/midarrlabs/web-push-elixir","last_synced_at":"2025-08-20T16:31:58.618Z","repository":{"id":195706290,"uuid":"693478639","full_name":"midarrlabs/web-push-elixir","owner":"midarrlabs","description":"Simple web push library for Elixir","archived":false,"fork":false,"pushed_at":"2025-05-28T10:15:10.000Z","size":113,"stargazers_count":24,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-15T15:25:13.877Z","etag":null,"topics":["elixir","elixir-lang","elixir-library","push-notifications","web-push","web-push-notifications"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/web_push_elixir","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/midarrlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"zenodo":null},"funding":{"github":"trueChazza"}},"created_at":"2023-09-19T05:35:58.000Z","updated_at":"2025-05-14T01:51:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"8448ad9a-143a-446f-a0e7-1d5bc37b737b","html_url":"https://github.com/midarrlabs/web-push-elixir","commit_stats":null,"previous_names":["midarrlabs/web-push-elixir"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/midarrlabs/web-push-elixir","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midarrlabs%2Fweb-push-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midarrlabs%2Fweb-push-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midarrlabs%2Fweb-push-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midarrlabs%2Fweb-push-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/midarrlabs","download_url":"https://codeload.github.com/midarrlabs/web-push-elixir/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midarrlabs%2Fweb-push-elixir/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271349634,"owners_count":24744317,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["elixir","elixir-lang","elixir-library","push-notifications","web-push","web-push-notifications"],"created_at":"2024-11-09T15:12:45.754Z","updated_at":"2025-08-20T16:31:57.727Z","avatar_url":"https://github.com/midarrlabs.png","language":"Elixir","readme":"\n# Web Push Elixir\n\nSimple web push library for Elixir\n\n\u003ca href=\"https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml\"\u003e\n    \u003cimg src=\"https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml/badge.svg\" alt=\"Test Status\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/midarrlabs/web-push-elixir\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/midarrlabs/web-push-elixir/branch/main/graph/badge.svg?token=8PJVJG09RK\u0026style=flat-square\" alt=\"Code Coverage\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://hex.pm/packages/web_push_elixir\"\u003e\n    \u003cimg alt=\"Hex Version\" src=\"https://img.shields.io/hexpm/v/web_push_elixir.svg\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://hexdocs.pm/web_push_elixir\"\u003e\n    \u003cimg alt=\"Hex Docs\" src=\"http://img.shields.io/badge/api-docs-blue.svg?style=flat\"\u003e\n\u003c/a\u003e\n\n\n## Prerequisities\n\n* Elixir 1.15\n* OTP 24 / 25 / 26\n\n## Installation\n\n1. Add `web_push_elixir` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:web_push_elixir, \"~\u003e 0.4.0\"}\n  ]\nend\n```\n\n2. Run mix command to generate your Vapid public and private keys:\n\n```commandline\nmix generate.vapid.keys\n```\n\n3. Set config for your generated keys:\n\n```elixir\nconfig :web_push_elixir,\n  vapid_public_key: \"someVapidPublicKey\",\n  vapid_private_key: \"someVapidPrivateKey\",\n  vapid_subject: \"mailto:admin@email.com\"\n```\n\n## Usage\n\n`WebPushElixir` provides a simple `send_notification/2` that takes 2 arguments:\n\n* `subscription`: the subscription information received from the client - [example demo](https://midarrlabs.github.io/web-push-elixir/)\n* `message`: the message string.\n\n```elixir\nsubscription = '{\"endpoint\":\"https://some-push-service\",\"keys\":{\"p256dh\":\"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=\",\"auth\":\"tBHItJI5svbpez7KI4CCXg==\"}}'\nmessage = \"Some message\"\n\nWebPushElixir.send_notification(subscription, message)\n```\n\nFor more information on how to subscribe a client, permission UX and more - take a look at [https://web.dev/notifications/](https://web.dev/notifications/)\n\n## Run tests\n\n```commandline\nmix test\n```\n\n## License\n\nWeb Push Elixir is open-sourced software licensed under the [MIT license](LICENSE).\n\n\n## Credits\n\nHeavily inspired by [elixir-web-push-encryption](https://github.com/danhper/elixir-web-push-encryption)\n","funding_links":["https://github.com/sponsors/trueChazza"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidarrlabs%2Fweb-push-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmidarrlabs%2Fweb-push-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidarrlabs%2Fweb-push-elixir/lists"}