TwilioDevEd/verify-v2-quickstart-node

Twilio Verify Quickstart with Twilio, Node.js, and Express

This template is part of Twilio CodeExchange. If you encounter any issues with this code, please open an issue at github.com/twilio-labs/code-exchange/issues.

About

This application example demonstrates how to do simple phone verification with Nodejs and Twilio Verify.

Read the full quickstart here!

Implementations in other languages:

.NET	Java	Python	PHP	Ruby
Done	Done	Done	Done	Done

Set up

Requirements

• Nodejs v10 or v12
• Sqlite3

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 / TWILIO_AUTH_TOKEN	For Twilio API credentials find here
VERIFICATION_SID	For Verification Service SID here

Local development

1. First clone this repository and cd into it.

   git clone git@github.com:TwilioDevEd/verify-v2-quickstart-node.git
   cd verify-v2-quickstart-node

2. Install dependencies.

   npm install

3. Set your environment variables. Copy the env.example file and edit it.

   cp .env.example .env

   See Twilio Account Settings to locate the necessary environment variables.

4. Run the web app.

   npm start

5. The application should now be running on http://localhost:3000/, here you can register a new user account and proceed with a phone verification.

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.

Tests

You can run the tests locally by typing:

npm test

Cloud deployment

Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.

Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.

Service
Heroku

Resources

• The CodeExchange repository can be found here.

Contributing

This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.