Vonage Video API Demo

This is a demo application built in Ruby using Ruby on Rails and the Vonage Ruby SDK to demonstrate the basic functionality of the Vonage Video API.

Pre-requisites

To run this demo locally you will need:

• A Vonage Developer account
• Ruby installed
• Ngrok installed

Setting up your Vonage Application

You'll need to set up a Vonage application to manage the capabilities and obtain the API credentials for this app.

1. Log onto the Vonage Developer Dashboard

2. Go to the Applications page and click on the 'Create a new application' button

3. Generate a private key for the application by clicking on the 'Generate public and private key' button. Download the private.key file and keep it somewhere safe.

4. Under 'Capabilities', enable the application for Video by toggling the switch to 'on'.

5. Click on the 'Generate new application' button at the bottom. This will generate and Application ID for the Vonage application; make a note of this or copy it to your clipboard for later.

Running the Demo Locally

1. Open Terminal and navigate to wherever you want to clone the repository.

2. Clone the repository

   git clone https://github.com/Vonage-Community/demo-video-ruby_on_rails-basic_video_call.git
   

3. Change directory (cd) into the root directory of the cloned repository and install the dependencies

   bundle install
   

4. Run the database migrations:

   rails db:migrate
   

5. Copy or move the private.key file you downloaded earlier the root directory of this demo application

6. Copy or rename the .env-example file to .env and update the file with your Vonage credentials:

   • VONAGE_APPLICATION_ID. This is the Application ID you generated earlier when creating the Vonage Application

7. Start up Ngrok

   ngrok http 3000
   

8. Copy the Ngrok Forwarding URL and set this in the .env file as the value for SITE_URL

9. In a separate Terminal tab, start the Rails application

   rails s
   

10. In your browser, navigate to localhost:3000. The demo should now be running in the browser.

11. Some functionality within the demo (such as creating new calls or ending existing calls) requires a logged in user. You can create a user locally by using the Rails Console. In a separate Terminal tab, open the Rails console

    rails c
    

12. Create a user record in the Rails console:

    User.create!(username: 'YOUR-USERNAME', password: 'YOUR-PASSWORD')