https://github.com/novuhq/novu-elixir

Elixir SDK for Novu
https://github.com/novuhq/novu-elixir

elixir-lang elixir-sdk hacktoberfest hacktoberfest-accepted notifications novu sdk

Last synced: about 2 months ago
JSON representation

Elixir SDK for Novu

• Host: GitHub
• URL: https://github.com/novuhq/novu-elixir
• Owner: novuhq
• License: mit
• Created: 2022-08-30T16:44:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T20:14:33.000Z (10 months ago)
• Last Synced: 2024-05-19T06:19:09.891Z (8 months ago)
• Topics: elixir-lang, elixir-sdk, hacktoberfest, hacktoberfest-accepted, notifications, novu, sdk
• Language: Elixir
• Homepage: https://hexdocs.pm/novu
• Size: 111 KB
• Stars: 27
• Watchers: 6
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Novu

[![CI](https://github.com/novuhq/elixir/actions/workflows/ci.yml/badge.svg)](https://github.com/novuhq/elixir/actions/workflows/ci.yml)

An Elixir SDK for [Novu](https://novu.co/).

## Installation

Novu is available on [hex.pm](https://hex.pm/packages/novu). Just add this line to your `mix.exs` file:

```elixir

def deps do

  [

    {:novu, "~> 0.3.0"}

  ]

end

```

## Configuration

Some parameters are configurable for use during the execution of requests, typically in `config/config.exs`. The following variables can be configured:

```elixir

config :novu,

  api_key: "api_key",  # required: your api key

  domain: "domain",  # required: your domain

  wait_min: 1000,  # optional: the minimum time to retry a request is milliseconds (default: 1000)

  wait_max: 10_000,  # optional: the maximum time to retry a request is milliseconds (default: 10_000)

  max_retries: 3,  # optional: the amount of retries in case of responses 408/429/500/502/503/504 (default: 0)

  retry_log_level: :warning  # optional: the log level to emit retry logs at. Can be set to false do disable logging (default: :warning)

```

## Documentation

Documentation is generated using `ex_doc` and published to [HexDocs](https://hexdocs.pm/novu/readme.html) on new releases. This is automatic, so our only ask is ensure public functions have proper documentation and examples provided.

## Contributing

First off, thank you for for showing an interest in contributing to the Elixir SDK for Novu! We have created a [contributing guide](./CONTRIBUTING.md) that will show you how to setup a development environment and how to open pull requests.