Merge pull request #95 from twilio/VIDEO-7546-setup-proxy

Video 7546 setup proxy

.env.example

@@ -1,6 +1,13 @@
 ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
+
+# WEB_PROXY_URL is used for local development with the 'npm start' command.
+# To get a URL, first deploy the app with 'npm run serverless:deploy'.
+# Then take note of the URL that is printed to the console. Do not include
+# the passcode.
+# WEB_PROXY_URL=https://twilio-live-interactive-video-1234-5678-dev.twil.io
+
 # Uncomment to run in stage environment.
 # Must also use correct credentials for stage.
 # REACT_APP_TWILIO_ENVIRONMENT=stage

README.md

@@ -45,7 +45,7 @@ If you make any changes to this application, you can run `npm run serverless:rem
 
 **NOTE:** The Twilio Function that provides access tokens via a passcode should _NOT_ be used in a production environment. This token server supports seamlessly getting started with the collaboration app, and while convenient, the passcode is not secure enough for production environments. You should use an authentication provider to securely provide access tokens to your client applications. You can find more information about Programmable Video access tokens [in this tutorial](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens).
 
-The passcode will expire after one week. To generate a new passcode, run `npm run serverless:deploy -- --override`.
+The passcode will expire after one week. To generate a new passcode, run `npm run serverless:deploy -- --override`. Additionally, you may run `npm run serverless:list` to see your deployed app's URL and passcode, or you can run `npm run serverless:remove` to delete the Serverless app from Twilio.
 
 #### Max Stream Duration
 
@@ -65,6 +65,12 @@ If you join a stream as an audience member, you can raise your hand to request t
 
 The application uses the [`video-composer-v1` Media Extension](https://www.twilio.com/docs/live/video-composer), which formats the Video Room contents in a responsive grid for streaming to audience members. People viewing the live stream will see all of the Video Room participants, and the grid will change as participants enter or exit.
 
+#### Web app local development
+
+To run the web app locally, you must first deploy the backend functions to Twilio Serverless. First, run `npm run serverless:deploy`, and then copy the URL of the deployed app to your `.env` file as the `WEB_PROXY_URL` variable (see [.env.example](.env.example) for an example). Then, run `npm run develop:web` to start the local development server. Any API requests made by the locally running app will be proxied to the URL provided as the `WEB_PROXY_URL`. 
+
+If you want to edit the functions that have been deployed to Twilio Serverless, you can do so in the [Twilio Console Functions Editor](https://www.twilio.com/changelog/all-new-functions-and-assets-ui-now-available). 
+
 ### Run the iOS App
 
 #### Open the Project in Xcode