twiliodeved/notifier-node

ARCHIVED - Notifier and SMS Notifications with Express and Twilio

Archived - Notifier and SMS Notifications with Twilio Notify

Please see the docs for Twilio Notify to try out notifications.

Description

Tag users and send group notifications with one request. Twilio alerts everyone that matches the specified tags.

Local Development

This project is build using Express web framework.

1. First clone this repository and cd into it.

   $ git clone [email protected]:TwilioDevEd/notifier-node.git
   $ cd notifier-node

2. Install dependencies.

   $ npm install
   

3. Copy the .env.example file to .env, and edit it including your credentials for the Twilio API (found at https://www.twilio.com/console). You will also need a Twilio Number.

   You can find your TWILIO_NOTIFICATION_SERVICE_SID in your Twilio console under services.

   Run source .env to export the environment variables.

4. Make sure the tests succeed.

   $ npm test

5. Start the server.

   $ npm start

6. Check it out at http://localhost:3000.

How to Demo

For Help Instructions

1. Text your Twilio number "help me". e.g.

   Help me
   

2. Receive a message with instructions.

To Create a Subscription

1. Text your Twilio number the name of the tag that you want to subscribe to. e.g.

   Rogue One
   

   Note: The available movies are "Han Solo Spinoff", "Rogue One", and "Episode VIII".

2. Receive a confirmation message.

To Delete a Subscription

1. Text your Twilio number with "unsub tag". e.g.

   unsub Rogue One
   

2. Receive a confirmation message.

Meta

• No warranty expressed or implied. Software is as is. Diggity.
• MIT License
• Lovingly crafted by Twilio Developer Education.

notifier-node's Issues

Quality Tweaks

1. After the end of every sentence put an space right after the .. This avoids some sms clients interpret this as an url.
2. Rename Episode VII to Episode VIII in the README.md.

Notification_SID?

The link in read_me for the notification service SID does not work. Upon more exploration it shows that this is in Beta release and normal users cannot access 'notification' service?

Doesn't this pretty much render your app unusable?

Shorter help message

"Help me" is the current command to request for help, but if its analyzed as a command Help would be the command and me would be a parameter, which may be redundant if it wont be used for nothing more. And its more intuitive having a command in lowercase. It may be like the regular help parameter:

Text your Twilio number for help:

  help

Cannot Read Property Length

Aside from not being able to requisition a new Notification service at twilio I decided to try to use an existing SMS Messaging app and input the SID from that app into .env. Upon following the instructions exactly, NPM throws this error:

TypeError: /Users/verbal/notifier-node/views/layout.pug:23
21| span.icon-bar
22| .container

23| for data in flash
24| .alert.alert-dismissible.alert-success
25| button.close(type='button', data-dismiss='alert') ×
26| span= data.message

Cannot read property 'length' of undefined
at eval (eval at wrap (/Users/verbal/notifier-node/node_modules/pug-runtime/wrap.js:6:10), :51:31)
at eval (eval at wrap (/Users/verbal/notifier-node/node_modules/pug-runtime/wrap.js:6:10), :82:4)
at template (eval at wrap (/Users/verbal/notifier-node/node_modules/pug-runtime/wrap.js:6:10), :116:155)
at Object.exports.renderFile (/Users/verbal/notifier-node/node_modules/pug/lib/index.js:410:38)
at Object.exports.renderFile (/Users/verbal/notifier-node/node_modules/pug/lib/index.js:400:21)
at View.exports.__express as engine
at View.render (/Users/verbal/notifier-node/node_modules/express/lib/view.js:126:8)
at tryRender (/Users/verbal/notifier-node/node_modules/express/lib/application.js:639:10)
at EventEmitter.render (/Users/verbal/notifier-node/node_modules/express/lib/application.js:591:3)
at ServerResponse.render (/Users/verbal/notifier-node/node_modules/express/lib/response.js:960:7)

Fix README.md

Before the 3rth step Make sure the tests succeed it should be the an instalation step:

1. Install the dependencies with npm

   $  npm install