Skip to content

TwilioDevEd/appointment-reminders-node

Repository files navigation

Twilio

Appointment Reminders. Powered by Twilio - Node.js/Express

Node.js CI

Use Twilio to create automatic appointment reminders for your business users. For a step-by-step tutorial see twilio docs.

Local development

First you need to install Node.js.

  1. This sample application stores data in a MongoDB database using Mongoose. You can download and run MongoDB yourself (on OS X, Linux or Windows).

    On OS X, maybe the easiest way to get MongoDB running locally is to install it via Homebrew.

    brew tap mongodb/brew
    brew install mongodb-community

    You should then be able to run a local server with:

    mongod

To run the app locally:

  1. Clone this repository and cd into it

    git clone git@github.com:TwilioDevEd/appointment-reminders-node.git
    
    cd appointment-reminders-node
  2. Install dependencies

    npm install
  3. Copy the sample configuration file and edit it to match your configuration

    cp .env.example .env

    You can find your TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN in your Twilio Account Settings. You will also need a TWILIO_PHONE_NUMBER, which you may find here.

    You can reuse the MONGO_URL_TEST for MONGO_URL for most default installs. Otherwise, use your production Mongo installation.

    Run source .env to export the environment variables

  4. Run the application

    npm start

    Alternatively 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.

    npm install -g nodemon
    nodemon ./bin/www
  5. Check it out at http://localhost:3000

That's it

Run the tests

You can run the tests locally by typing

npm test

Meta

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