Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codedge-llc/pigeon
iOS and Android push notifications for Elixir
https://github.com/codedge-llc/pigeon
adm amazon android apns elixir fcm hex ios
Last synced: 4 days ago
JSON representation
iOS and Android push notifications for Elixir
- Host: GitHub
- URL: https://github.com/codedge-llc/pigeon
- Owner: codedge-llc
- License: mit
- Created: 2015-09-06T04:04:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T21:20:19.000Z (3 months ago)
- Last Synced: 2024-10-29T21:59:27.022Z (about 1 month ago)
- Topics: adm, amazon, android, apns, elixir, fcm, hex, ios
- Language: Elixir
- Homepage: https://hex.pm/packages/pigeon
- Size: 645 KB
- Stars: 644
- Watchers: 17
- Forks: 145
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - HTTP2-compliant wrapper for sending iOS and Android push notifications. (Third Party APIs)
- fucking-awesome-elixir - pigeon - HTTP2-compliant wrapper for sending iOS and Android push notifications. (Third Party APIs)
- awesome-elixir - pigeon - HTTP2-compliant wrapper for sending iOS and Android push notifications. (Third Party APIs)
README
> HTTP2-compliant wrapper for sending iOS and Android push notifications.
[](https://github.com/codedge-llc/pigeon/actions/workflows/ci.yml)
[](https://hex.pm/packages/pigeon)
[](https://hex.pm/packages/pigeon)
[](https://github.com/codedge-llc/pigeon/blob/master/LICENSE)
[](https://github.com/codedge-llc/pigeon/commits/master)
[](https://hexdocs.pm/pigeon/)
_Pigeon v2.0 is in release candidate status. See [the latest stable 1.6 on Hex](https://hex.pm/packages/pigeon)
or [the 1.6 branch on GitHub](https://github.com/codedge-llc/pigeon/tree/v1.6) for installation._
## Installation
Add `:pigeon` and as a `mix.exs` dependency:
```elixir
def deps do
[
{:pigeon, "~> 2.0.0-rc.3"}
]
end
```
## Getting Started
Check the module documentation for your push notification service.
- [Pigeon.ADM](https://hexdocs.pm/pigeon/2.0.0-rc.2/Pigeon.ADM.html) - Amazon Android.
- [Pigeon.APNS](https://hexdocs.pm/pigeon/2.0.0-rc.2/Pigeon.APNS.html) - Apple iOS.
- [Pigeon.FCM](https://hexdocs.pm/pigeon/2.0.0-rc.2/Pigeon.FCM.html) - Firebase Cloud Messaging v1 API.
### Creating Dynamic Runtime Dispatchers
Pigeon can spin up dynamic dispatchers for a variety of advanced use-cases, such as
supporting dozens of dispatcher configurations or custom connection pools.
See [Pigeon.Dispatcher](https://hexdocs.pm/pigeon/2.0.0-rc.1/Pigeon.Dispatcher.html) for instructions.
### Writing a Custom Dispatcher Adapter
Want to write a Pigeon adapter for an unsupported push notification service?
See [Pigeon.Adapter](https://hexdocs.pm/pigeon/2.0.0-rc.1/Pigeon.Adapter.html) for instructions.
## Contributing
### Testing
Unit tests can be run with `mix test` or `mix coveralls.html`. Environment variables will need to be set for
various credentials. See [config/test.exs](https://github.com/codedge-llc/pigeon/blob/master/config/test.exs)
for the full list.
### Formatting
This project uses Elixir's `mix format` and [Prettier](https://prettier.io) for formatting.
Add hooks in your editor of choice to run it after a save. Be sure it respects this project's
`.formatter.exs`.
### Commits
Git commit subjects use the [Karma style](http://karma-runner.github.io/5.0/dev/git-commit-msg.html).
## License
Copyright (c) 2015-2024 Codedge LLC (https://www.codedge.io/)
This library is MIT licensed. See the [LICENSE](https://github.com/codedge-llc/pigeon/blob/master/LICENSE) for details.