Agent Notes Plugin

This Twilio Flex Plugin enables your agents to take notes when they are chatting with a customer. This is an introductory plugin where the notes are stored locally for your agents.

To learn more about developing plugins on your Flex instance, refer to the getting started guide.

Project Structure

This project is based on a sample plugin developed using the Flex Plugin Builder.

Setup

Make sure you have Node.js as well as npm installed.

Afterwards, install the dependencies by running npm install:

git clone https://github.com/twilio-labs/plugin-agent-notes
cd plugin-agent-notes
npm install

Development

In order to develop locally, you can use the Webpack Dev Server by running:

twilio flex:plugins:start

This will automatically start up the Webpack Dev Server and open the browser for you. Your app will run on http://localhost:3000. If you want to change that you can do this by setting the PORT environment variable:

PORT=3001 twilio flex:plugins:start

When you make changes to your code, the browser window will be automatically refreshed.

Type twilio flex:plugins:start --help to get more detailed information about the command.

Deploy and Release Plugin

When you are ready to deploy your plugin, in your terminal run:

twilio flex:plugins:deploy --major --changelog "Adding Agent Notes" --description "Ability for agents to take notes"

This will upload your plugin to Flex. After a deployment, your plugin is not yet enabled for all your users on your Flex application. You need to run the release command after the deploy to enable any changes:

flex:plugins:release --name "Plugin Release-Agent Notes" --description "Enabling plugin agent notes" --plugin plugin-agent-notes@latest

For more details on deploying your plugin, refer to the deploying your plugin guide.

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alice Cai 🐛 💻 📖 🎨 💬

Kousha Talebian 🐛 💻 📖 🎨 💬

Ben 🐛 💻 📖 🎨 💬

Ruma 🐛 💻 📖 🎨 💬

This project follows the all-contributors specification. Contributions of any kind welcome!