Code Monkey home page Code Monkey logo

owl-shoes-web-ui's Introduction

OWL Shoes Retial Web

OWL Shoes Retail Web is an application that demonstrates a website chat widget built for Flex Conversations. It uses Twilio's Conversations JS SDK, Twilio Paste Design library, the Flex WebChats endpoint, Twilio Functions and React.


  1. Getting started
    1. Setup Functions
    2. Setup React App
    3. Work locally
  2. Deployment

Getting Started

Setup Functions

First we need to setup the server to handle token generation for web chat.

1. Install Dependencies

Node supported version is 14 only.
npm install

2. Populate Your .env File

We provide a handy bootstrap script to set up the environment variables, but you can alternatively copy the .env.sample file.

npm bootstrap \
accountSid=YOUR_ACCOUNT_SID \
authToken=YOUR_AUTH_TOKEN \
apiKey=YOUR_API_KEY_SID \
apiSecret=YOUR_API_SECRET \
addressSid=YOUR_ADDRESS_SID \
conversationsServiceSid=YOUR_CONVERSATIONS_SERVICE_SID \
sfdcInstanceUrl=YOUR_SFDC_INSTANCE_URL \
sfdcUserName=YOUR_SFDC_USER_NAME \
sfdcPassword=YOUR_SFDC_PASSWORD \
sfdcSecurityToken=YOUR_SFDC_SECURITY_TOKEN \
sendgridApiKey=YOUR_SENDGRID_API_KEY \
sendgridFromEmail=YOUR_SENDGRID_FROM_EMAIL \
sendgridTemplateId=YOUR_SENDGRID_TEMPLATE_ID \

You can find your Account Sid and Auth Token on the main Twilio Console page.

For more info on how to create an API key and an API secret, please check the documentation.

You can find your Conversations Service Sid on the services page. Make sure to pick the one linked to your Flex Account โ€” usually it is named Flex Chat Service and it starts with IS

For the Address Sid, Flex Acccount --> Messaging --> Conversations Address --> click on the edit button of your address and the edit screen will contain Address Sid on the column (Address Configuration SID) . Note this Sid starts with IG.

Setup React App

Checkout React app folder

cd assets-src

Install dependencies

npm install

Update server port

cp .env.sample .env

Update the twilio function server url

Working Locally

From the root folder

1. Start the Local Backend Server

npm run server

Your server will be served at http://localhost:3001/.

2. Start the Local React App Server

npm start

Your app will be served at http://localhost:3000/.

Deployment

The project can be deployed as a Twilio Service

Deploy to twilio serverless

npm run deploy
After the flow is created. We need to map the flow to flex task routing. 

Deploy studio flows and update messaging

npm run deploy-flows

Update studio workflow and routing based on product user is searched on

Refer the run books to configure the agent routing

License

MIT ยฉ Twilio Inc.

owl-shoes-web-ui's People

Contributors

ashikmeerankutty avatar sandeepnandula avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

nokenwa

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.