sos-sms v1.3.0

sos-sms

Send error messages via Twilio with ease!

This npm package is designed to be used in conjunction with a backend to provide data persistence. Find the corresponding backend project here (it's free and open source but you will have to set it up yourself): https://github.com/401-Team-Awesome/sos-sms-server

Contributors: Carl Olson, Cara Ottmar, Sarah Bixler, Zachary Schumpert

Install

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install sos-sms

You will need to include a configuration or process environment variable that holds your backend api url. Name the variable SOS_SMS_API so that it will look like

SOS_SMS_API=http://example-backend-api.com

Example

sossms(errorCode, userID, message);

const userID = '1234567'
const errorCode = '500'
const message = 'Red Alert!'

sossms(errorCode, userID, message);

The userID is a unique code that a user will receive after creating an account.

License

MIT