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: 6 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: main
• Last Pushed: 2024-12-28T16:33:16.000Z (22 days ago)
• Last Synced: 2025-01-04T11:37:35.614Z (15 days ago)
• Topics: adm, amazon, android, apns, elixir, fcm, hex, ios
• Language: Elixir
• Homepage: https://hex.pm/packages/pigeon
• Size: 663 KB
• Stars: 651
• Watchers: 17
• Forks: 146
• Open Issues: 40
• 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

        
![logo](https://raw.githubusercontent.com/codedge-llc/pigeon/master/docs/logo.png)

> iOS (APNS), Android (FCM), and Amazon Android (ADM) push notifications for Elixir.

[![CI](https://github.com/codedge-llc/pigeon/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/pigeon/actions/workflows/ci.yml)

[![Version](https://img.shields.io/hexpm/v/pigeon.svg)](https://hex.pm/packages/pigeon)

[![Total Downloads](https://img.shields.io/hexpm/dt/pigeon.svg)](https://hex.pm/packages/pigeon)

[![License](https://img.shields.io/hexpm/l/pigeon.svg)](https://github.com/codedge-llc/pigeon/blob/master/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/codedge-llc/pigeon.svg)](https://github.com/codedge-llc/pigeon/commits/master)

[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/pigeon/)

## Installation

Add `:pigeon` and as a `mix.exs` dependency:

```elixir

def deps do

  [

    {:pigeon, "~> 2.0"}

  ]

end

```

## Upgrading from v1.6

See the [migration guide](./docs/Migrating-to-v2-0-0.md) for instructions.

## Getting Started

Check the module documentation for your push notification service.

- [Pigeon.ADM](https://hexdocs.pm/pigeon/Pigeon.ADM.html) - Amazon Android.

- [Pigeon.APNS](https://hexdocs.pm/pigeon/Pigeon.APNS.html) - Apple iOS.

- [Pigeon.FCM](https://hexdocs.pm/pigeon/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/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/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.