Skip to content

TwilioDevEd/verify-v2-quickstart-rails

Repository files navigation

Twilio

Twilio Verify Quickstart with Twilio and Rails

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 Ruby on Rails Framework, and Twilio Verify.

Learn more about Account Security and when to use the Authy API vs the Verify API in the Account Security documentation.

Implementations in other languages:

.NET Java Python PHP Node
Done Done Done Done Done

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

Local Development

  1. Clone the project and cd into it.

    git clone https://github.com/TwilioDevEd/verify-v2-quickstart-rails.git
    cd verify-v2-quickstart-rails/
  2. Install gem dependencies.

    make install
  3. Copy .env file.

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

  4. Create the database and run migrations.

     make database
  5. Run the application.

    make serve
  6. Navigate to http://localhost:3000

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:

bundle exec rails 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 Deploy

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.