{"id":13402618,"url":"https://github.com/twilio/video-quickstart-js","last_synced_at":"2025-05-15T03:02:52.462Z","repository":{"id":20299797,"uuid":"87865581","full_name":"twilio/video-quickstart-js","owner":"twilio","description":"A quickstart and code samples for Twilio Video JavaScript SDK. https://www.twilio.com/docs/video","archived":false,"fork":false,"pushed_at":"2025-03-28T15:28:48.000Z","size":1002,"stargazers_count":391,"open_issues_count":8,"forks_count":339,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-05-13T21:17:10.842Z","etag":null,"topics":["quickstart","twilio","twilio-video","video","videochat","videojs","webrtc","webrtc-video"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/twilio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-04-10T23:05:23.000Z","updated_at":"2025-03-21T16:44:10.000Z","dependencies_parsed_at":"2024-01-16T10:34:44.322Z","dependency_job_id":"67942bb0-82dd-4521-8b84-ef85c8f44dc5","html_url":"https://github.com/twilio/video-quickstart-js","commit_stats":{"total_commits":106,"total_committers":13,"mean_commits":8.153846153846153,"dds":0.6320754716981132,"last_synced_commit":"2734a083a8a2b3e77f1436d7cee8bc9ec18a94f0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twilio%2Fvideo-quickstart-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twilio%2Fvideo-quickstart-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twilio%2Fvideo-quickstart-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twilio%2Fvideo-quickstart-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/twilio","download_url":"https://codeload.github.com/twilio/video-quickstart-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254264737,"owners_count":22041789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["quickstart","twilio","twilio-video","video","videochat","videojs","webrtc","webrtc-video"],"created_at":"2024-07-30T19:01:18.419Z","updated_at":"2025-05-15T03:02:52.250Z","avatar_url":"https://github.com/twilio.png","language":"JavaScript","readme":"# Twilio Video Quickstart for JavaScript\n\n[![OS X/Linus Build Status](https://secure.travis-ci.org/twilio/video-quickstart-js.png?branch=master)](http://travis-ci.org/twilio/video-quickstart-js) [![Windows Build status](https://ci.appveyor.com/api/projects/status/3u69uy9c0lsap3dr?svg=true)](https://ci.appveyor.com/project/markandrus/video-quickstart-js)\n\n_For Twilio Video 1.x Quickstart, go [here](https://github.com/twilio/video-quickstart-js/tree/1.x)._\n\n## Overview\n\nThis application should give you a ready-made starting point for writing your\nown video apps with Twilio Video.\n\n![screenshot of chat app](quickstart/public/quickstart.png)\n\n## Setup Requirements\n\nBefore we begin, we need to collect all the config values we need to run the application:\n\n- Account SID: Your primary Twilio account identifier - find this [in the console here](https://www.twilio.com/console).\n- API Key SID: Used to authenticate - [generate one here](https://www.twilio.com/console/runtime/api-keys).\n- API Key Secret: Used to authenticate - [just like the above, you'll get one here](https://www.twilio.com/console/runtime/api-keys).\n\n### A Note on API Keys\n\nWhen you generate an API key pair at the URLs above, your API Key Secret will only\nbe shown once - make sure to save this in a secure location,\nor possibly your `~/.bash_profile`.\n\n## Setting Up The Application\n\nCreate a configuration file for your application:\n\n```bash\ncp .env.template .env\n```\n\nEdit `.env` with the configuration parameters we gathered from above.\n\nNext, we need to install our dependencies from npm:\n\n```bash\nnpm install\n```\n\n## Running The Application\n\nNow we should be all set! Run the application:\n\n```bash\nnpm start\n```\n\nYour application should now be running at [http://localhost:3000](http://localhost:3000). You will\nbe prompted to test and choose your microphone and camera. On desktop browsers, your choices will\nbe saved. _On mobile browsers, you will be asked to test and choose your microphone and camera every\ntime you load the application in order to make sure they are not reserved by another application_.\n\nAfter choosing your input devices, you will be prompted to enter your Room name and user name, following\nwhich you will join the Room. Now, all you have to do is open another tab and join the same Room in order\nto see and hear yourself on both tabs!\n\n[joinroom.js](quickstart/src/joinroom.js) demonstrates how to use the SDK APIs to build a multi-party\nvideo sesssion. You can start building your own application by incorporating this code into your own\napplication, and build your user interface around it.\n\n## Running On Multiple Devices\n\nYou can use [ngrok](https://ngrok.com/) to try your application\non different devices by creating a secure tunnel to your application server:\n\n```bash\nngrok http 3000\n```\n\nYou will get a URL of the form `https://a1b2c3d4.ngrok.io` which can be loaded on a browser from a device\ndifferent than the one where your application server is running.\n\n## Examples\n\nThe project contains some use-case examples for the Twilio Video JS SDK. After running the application\nby following the instructions above, go to [http://localhost:3000/examples](http://localhost:3000/examples)\nto try them out.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwilio%2Fvideo-quickstart-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwilio%2Fvideo-quickstart-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwilio%2Fvideo-quickstart-js/lists"}