Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

TwilioDevEd/clicktocall-node

Repository files navigation

Twilio

Click to Call - Node.js

This repository is archived and no longer maintained. Check out the Twilio Voice docs for links to other tutorials.

Set up

Requirements

Twilio Account Settings

This application should give you a ready-made starting point for writing your own application. Before we begin, we need to collect all the config values we need to run the application:

Config Value Description
TWILIO_ACCOUNT_SID Your primary Twilio account identifier - find this in the Console.
TWILIO_AUTH_TOKEN Used to authenticate - just like the above, you'll find this here.
TWILIO_NUMBER A Twilio phone number in E.164 format - you can get one here

Local Development

  1. First clone this repository and cd into it.

    git clone https://github.com/TwilioDevEd/clicktocall-node.git
    cd clicktocall-node
  2. Install the dependencies.

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

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

  4. Launch local development web server, will run on port 3000.

    npm start
  5. For Twilio to be able to talk to your application, you'll need a way to make your server publicly available to the internet. For local testing purposes, we recommend using ngrok. Ngrok provides secure introspectable tunnels to localhost webhook development: for more information and instructions on setting up ngrok to work with your application, check out this section of the Click to Call tutorial.

    ngrok http 3000
  6. Finally, open up your browser and go to your ngrok URL. It will look something like this: http://<sub-domain>.ngrok.io

That's it!

Docker

If you have Docker already installed on your machine, you can use our docker-compose.yml to setup your project.

  1. Make sure you have the project cloned.
  2. Setup the .env file as outlined in the Local Development steps.
  3. Run docker-compose up.
  4. Follow the steps in Local Development on how to expose your port to Twilio using a tool like ngrok and configure the remaining parts of your application.

Tests

To execute tests, run the following command in the project directory:

npm test

Resources

  • The CodeExchange repository can be found here.

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.