Skip to content

dameleney/server-notifications-node

 
 

Repository files navigation

Server notifications with Twilio, Node.js, and Express

Build Status

Use Twilio to send SMS alerts so that you never miss a critical issue.

Read the full tutorial here!

Running the Project on Your Machine

To run this project on your computer, download or clone the source. You will also need to download and install either Node.js or io.js, both of which should also install npm.

You will also need to sign up for a Twilio account if you don't have one already.

Install Dependencies

Navigate to the project directory in your terminal and run:

npm install

This should install all of our project dependencies from npm into a local node_modules folder.

Configuration

Next, open .env.example at the root of the project and update it with values from your Twilio account and local configuration. Save the file as .env. You'll need to set TWILIO_AUTH_TOKEN, TWILIO_ACCOUNT_SID, and TWILIO_NUMBER.

For the TWILIO_NUMBER variable you'll need to provision a new number in the Manage Numbers page under your account. The phone number should be in E.164 format

Running the Project

To launch the application, you can use node . in the project's root directory. You might also consider using nodemon for this. It works just like the node command, but automatically restarts your application when you change any source code files.

Make sure you have customized the config/administrators.json file with your phone number and then open http://localhost:3000/error. You'll get a text message shortly informing you of an exception.

npm install -g nodemon
nodemon .

Running Tests

Basic functional tests can be run with:

npm test

License

MIT

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.1%
  • HTML 5.9%