Click to Call 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

Click-to-call enables your company to convert web traffic into phone calls with the click of a button. This application is using Ruby on Rails. Learn how to implement it in minutes.

Read the full tutorial here!

Implementations in other languages:

.NET	Java	Python	PHP	Node
Done	Done	Done	Done	Done

Set up

Requirements

• Ruby 2.6.x version
• Sqlite3
• Node.js 10.x or 12.x version

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 and TWILIO_AUTH_TOKEN	You could find them on Twilio console here
API_HOST	The one generated by ngrok
TWILIO_NUMBER	You could get one on Twilio console here

Local Development

1. First clone this repository and cd into it.

   git clone git://github.com/TwilioDevEd/clicktocall-rails.git
   cd clicktocall-rails

2. Install the dependencies.

   make install

3. Set your environment variables.

   cp .env.example .env

   See Twilio Account Settings to locate the necessary environment variables. The phone number should be in E.164 format.

4. Setup server

   make serve-setup

5. Start the development server (will run on port 3000).

   make serve

6. Expose your application to the wider internet using ngrok. You can click here for more details. This step is important because the application won't work as expected if you run it through localhost.

   ngrok http 3000

7. Once ngrok is running, open up your browser and go to your ngrok URL. It will look like this: http://<ngrok-subdomain>.ngrok.io Then, enter a number in the box provided and click "Contact Sales" to initiate a call.

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

You can run the tests locally by runnung:

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

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.