https://abhijitmehta.github.io/plugin-flex-virtual-queue/
- setup the contact us page and related twilio function
- setup Flex plugin
Once you finish the above steps,
- proceed to the your instance of hosted flex to launch Flex
- in another tab, open the contact us form deployed at https://.twil.io/contact_us.htm
Read serverless/flex-virtual-queue
Twilio Flex Plugins allow you to customize the appearance and behavior of Twilio Flex. If you want to learn more about the capabilities and how to use the API, check out our Flex documentation.
Make sure you have Node.js as well as npm installed.
Afterwards, install the dependencies by running npm install:
cd
# If you use npm
npm installIn order to develop locally, you can use the Webpack Dev Server by running:
npm startThis will automatically start up the Webpack Dev Server and open the browser for you. Your app will run on http://localhost:8080. If you want to change that you can do this by setting the PORT environment variable:
PORT=3000 npm startWhen you make changes to your code, the browser window will be automatically refreshed.
Once you are happy with your plugin, you have to bundle it in order to deploy it to Twilio Flex.
Run the following command to start the bundling:
npm run buildAfterwards, you'll find in your project a build/ folder that contains a file with the name of your plugin project. For example, plugin-example.js. Take this file and upload it into the Assets part of your Twilio Runtime.
Note: Common packages like React, ReactDOM, Redux and ReactRedux are not bundled with the build because they are treated as external dependencies so the plugin will depend on Flex to provide them globally.
The primary new interface is an npm run deploy command. This command will build your plugin and deploy it to Twilio Assets from your CLI. You no longer need to drag-and-drop your plugin within the Twilio Console.
When you are ready to deploy your plugin, in your terminal run:
npm run deployThis will publish your plugin as a Private Asset that is accessible by the Functions & Assets API. If you want to deploy your plugin as a Public Asset, you may pass --public to your deploy command:
npm run deploy --public
For more information on Public vs Private plugins, please see (Deploying Flex Plugins)[https://www.twilio.com/docs/flex/plugins/deploying]
The output of above deploye command should look something like this:
abhijitMehta> SKIP_PREFLIGHT_CHECK=true npm run deploy --public
> [email protected] predeploy /Users/amehta/Workshop/virtual_queue/plugin-flex-virtual-queue
> npm run build
> [email protected] prebuild /Users/amehta/Workshop/virtual_queue/plugin-flex-virtual-queue
> rimraf build && npm run bootstrap
> [email protected] bootstrap /Users/amehta/Workshop/virtual_queue/plugin-flex-virtual-queue
> flex-plugin check-start
> [email protected] build /Users/amehta/Workshop/virtual_queue/plugin-flex-virtual-queue
> flex-plugin build
Creating an optimized production build...
Compiled successfully.
File sizes after gzip:
11.06 KB build/plugin-flex-virtual-queue.js
The project was built assuming it is hosted at /.
You can control this with the homepage field in your package.json.
The build folder is ready to be deployed.
You may serve it with a static server:
npm install -g serve
serve -s build
Find out more about deployment here:
bit.ly/CRA-deploy
> [email protected] deploy /Users/amehta/Workshop/virtual_queue/plugin-flex-virtual-queue
> flex-plugin deploy
Uploading your Flex plugin to Twilio Assets
? Enter your Twilio Account Sid: AC35234sb96a8dfadsf8sadfdsa862
? Enter your Twilio Auth Token: [hidden]
✔ Fetching Twilio Runtime service
✔ Validating the new plugin bundle
✔ Uploading your plugin bundle
✔ Registering plugin with Flex
✔ Deploying a new build of your Twilio Runtime
🚀 Your plugin has been successfully deployed to your Flex project clickToDialTutorial (AC35234sb96a8dfadsf8sadfdsa862). It is hosted (privately) as a Twilio Asset on https://default-<sdf234>-20j3dc.twil.io/plugins/plugin-flex-virtual-queue/0.0.0/bundle.js.
Workshop/virtual_queue/plugin-flex-virtual-queue via ⬢ v12.16.1 took 53s
abhijitMehta>