Skip to content

codedge-llc/pigeon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f4bd7a9 · Jan 31, 2025
Dec 28, 2024
Sep 10, 2024
Dec 9, 2024
Jan 31, 2025
Sep 10, 2024
Jul 5, 2021
Aug 6, 2022
Aug 6, 2022
Dec 20, 2024
Jan 31, 2025
Aug 30, 2024
Dec 28, 2024
May 15, 2021
Dec 28, 2024
Dec 28, 2024

Repository files navigation

logo

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

CI Version Total Downloads License Last Updated Documentation

Installation

Add :pigeon and as a mix.exs dependency:

def deps do
  [
    {:pigeon, "~> 2.0"}
  ]
end

Upgrading from v1.6

See the migration guide for instructions.

Getting Started

Check the module documentation for your push notification service.

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 for instructions.

Writing a Custom Dispatcher Adapter

Want to write a Pigeon adapter for an unsupported push notification service?

See Pigeon.Adapter 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 for the full list.

Formatting

This project uses Elixir's mix format and Prettier 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.

License

Copyright (c) 2015-2024 Codedge LLC (https://www.codedge.io/)

This library is MIT licensed. See the LICENSE for details.