https://github.com/mlomboglia/plugin-starter
Twilio Flex plugin with CD and Rollbar integration
https://github.com/mlomboglia/plugin-starter
circleci flex rollbar twilio-flex
Last synced: 4 months ago
JSON representation
Twilio Flex plugin with CD and Rollbar integration
- Host: GitHub
- URL: https://github.com/mlomboglia/plugin-starter
- Owner: mlomboglia
- Created: 2019-10-23T16:45:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-04T18:04:33.000Z (almost 6 years ago)
- Last Synced: 2025-01-04T07:43:59.188Z (9 months ago)
- Topics: circleci, flex, rollbar, twilio-flex
- Language: JavaScript
- Homepage:
- Size: 494 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Your custom Twilio Flex Plugin
Twilio Flex Plugins allow you to customize the appearance and behavior of [Twilio Flex](https://www.twilio.com/flex). If you want to learn more about the capabilities and how to use the API, check out our [Flex documentation](https://www.twilio.com/docs/flex).
## Setup
Make sure you have [Node.js](https://nodejs.org) as well as [`npm`](https://npmjs.com) installed.
Afterwards, install the dependencies by running `npm install`:
```bash
cd
# If you use npm
npm install
```
## Development
In order to develop locally, you can use the Webpack Dev Server by running:
```bash
npm start
```
This 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:
```bash
PORT=3000 npm start
```
When you make changes to your code, the browser window will be automatically refreshed.
## Deploy
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:
```bash
npm run build
```
Afterwards, 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.