Skip to content

fremantle-industries/notified

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notified

Build Status hex.pm version

An Elixir library for application notifications

This library is the core notification engine. For a frontend phoenix live UI check out notified_phoenix

Installation

Add the notified package to your list of dependencies in mix.exs:

def deps do
  [
    {:notified, "~> 0.0.6"}
  ]
end

Configuration

Configure the pubsub server

config :notified, pubsub_server: MyApp.PubSub

Usage

Create & manage a notification

notification = Notifed.create("Many Signups!", "10 users have signed up in the last 5 minutes", ["users", "campaign-1"])
Notifed.mark_seen(notification)
Notifed.delete(notification)

Notifications are stored in memory using ETS via etso. This means that notifications will not persist between application restarts.

Authors

License

notified is released under the MIT license

About

An Elixir library for application notifications

Resources

License

Stars

Watchers

Forks

Languages