npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

adonis-notify

v0.0.6

Published

Send notifications in AdonisJS using Twilio, Firebase Cloud Message and native Adonis Email service provider.

Downloads

3

Readme

Adonis Notify

Send notifications in AdonisJS using Twilio, Firebase Cloud Message and native Adonis Email service provider.

Installation

Add the package in your Adonis project.

npm install adonis-notify --save

Create a config file named notification.js in your project config folder.

'use strict';

const Env = use('Env');

module.exports = {
  twilio: {
    account_sid: '',
    authentication_token: '',
    notification_service: '',
    whatsapp: {
      number: '',
    },
  },

  firebase: {
    enviroment: '',
    database: {
      url: '',
    },
  },

  email: {
    sender: '',
  },
};

Add the new providers in your app.js

const providers = [
  ...
  'adonis-notify/providers/EmailProvider',
  'adonis-notify/providers/PushProvider',
  'adonis-notify/providers/SmsProvider',
  'adonis-notify/providers/WhatsappProvider',
];

Usage

Push Notifications

Before sending push notifications with firebase, add the following variable to your application: GOOGLE_APPLICATION_CREDENTIALS

See: https://cloud.google.com/docs/authentication/getting-started

const Push = use('Adonis/Notify/Push');

// Registering user device
Push.saveDevice(userDeviceToken, 'userTag');

// Sending pushs
const payload = {
  title: 'Your push title.',
  body: 'Your push message.'
}

Push.send([userDeviceTokens], payload);

You can also send an optional data attribute.

// Custom data
const payload = {
  title: 'Your push title.',
  body: 'Your push message.',
  data: {
    foo: 'bar',
    bar: 'foo'
  }
}

Sending Sms

const Sms = use('Adonis/Notify/Sms');

Sms.send('+5582999999999', 'Hello World!');

Sending Whatsapp messages

const Whatsapp = use('Adonis/Notify/Whatsapp');

Whatsapp.send('+5582999999999', 'Hello World!');

Sending Emails

Before sending emails, make sure you have set up Adonis' native email provider service. See: https://adonisjs.com/docs/4.1/mail

const Email = use('Adonis/Notify/Email');

const payload = {
  email: '[email protected]',
  template: 'your.edge.template',
  variables: {
    foo: 'bar',
    bar: 'foo',
  },
  subject: 'Cool email subject ;)',
};

Email.send(payload);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.