Skip to content

Update README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ This repository implements a Twilio Frontline integration service using Twilio S

## Prerequisites

We recommend following the setup outlined Frontline node.js quickstart, which shows you how to do the following:
We recommend following the setup outlined in the [Frontline node.js quickstart](https://www.twilio.com/docs/frontline/nodejs-demo-quickstart), or watching the [setup video](https://www.youtube.com/watch?v=KDrhR1HyrlE), which walk you through the following:

* A Twilio Account. Don't have one? [Sign up](https://www.twilio.com/try-twilio) for free!
* An SMS enabled [phone number](https://www.twilio.com/docs/frontline/nodejs-demo-quickstart#sign-up-for-a-twilio-account-and-get-a-phone-number).
* A [Twilio Frontline instance](https://www.twilio.com/docs/frontline/nodejs-demo-quickstart#create-a-new-twilio-frontline-instance).
* A [Twilio Frontline instance](https://www.twilio.com/docs/frontline/nodejs-demo-quickstart#create-a-new-twilio-frontline-instance).
**Note: I got an error here "Could not create environment," then upgraded my account to an employee account, refreshed, and it worked. Is it possible that frontline will not work on trial accounts? If so, we should make a note here.**
* Twilio Conversations [configured](https://www.twilio.com/docs/frontline/nodejs-demo-quickstart#configure-twilio-conversations) to use the Frontline Conversations service as it's default conversation service.
* Additionally, you'll need to [copy this Airtable Base template](https://airtable.com/shrbXF88oQlRh7ZXh) and have your [Airtable API key](https://support.airtable.com/hc/en-us/articles/219046777-How-do-I-get-my-API-key-) along with your [Base ID](https://support.airtable.com/hc/en-us/articles/4405741487383-Understanding-Airtable-IDs).

Once you reach the step to "Configure the Frontline Integration Service" you are ready to deploy this app.
Once you reach the step to "Configure the Frontline Integration Service" you are ready to deploy this app using the following directions - no need to follow any further steps in the quickstart documentation.

## Project Setup
Follow these steps to clone the repository, install dependencies, and set environment variables:
Expand All @@ -31,17 +32,21 @@ Follow these steps to clone the repository, install dependencies, and set enviro
git clone

# Change to the project directory:
cd frontline-airtable-quickstart
cd frontline-airtable-quickstart **note - this is different in the video**

# Install dependencies:
npm install

**note - in the video, the Okta setup steps occur before this**
**note - in the vidoe, when we get back from setting up Okta in Frontline, it tells us to Assign the Application, but does not make it clear how/where we navigate to do so**

# Copy the sample environment variables file to .env:
cp .env.example .env
```

### Environment Variables Reference
Here are the environment variables that must be configured for the app to run:
**note - the 'code' command is super slick - is that an iTerm thing?**

```bash
ACCOUNT_SID= # Your twilio account SID, found in the console.
Expand Down