Giter Club home page Giter Club logo

plugin-verify's Introduction

Twilio Flex Plugin for Verify

demo video

Setup

Requirements:

  1. Node version 10.19.0 or later (check version in your terminal with node -v).
  2. A Twilio account.
  3. A Flex project. Create a Flex project in the console.
  4. A Verify service. Create a new Verify service in the console.
  5. The Twilio CLI. Install the CLI for your operating system and login with your Flex account credentials using twilio login.
  6. The Twilio serverless plugin. Install from the command line with twilio plugins:install @twilio-labs/plugin-serverless. More details in the docs.
  7. The Twilio Flex plugin. Install from the command line with twilio plugins:install @twilio-labs/plugin-flex. More details on GitHub.

After cloning this repository, install dependencies with npm:

npm install

Deploy verification serverless functions

Copy the serverless config example and fill in the ACCOUNT_SID, AUTH_TOKEN, and VERIFY_SERVICE_SID:

cp serverless/.env.serverless.example serverless/.env

Deploy the functions with the Twilio CLI:

twilio serverless:deploy

Save the function URLs that display with the deployment details

Copy the.env.example in the project root to .env:

# in the project root
cp .env.example .env

Update the REACT_APP_SERVICE_BASE_URL to be your new function url.

REACT_APP_SERVICE_BASE_URL="http://verify-plugin-1234-dev.twil.io"

Run the plugin locally

twilio flex:plugins:start

Deploy the plugin

twilio flex:plugins:deploy

Known issues

  • "INFO" tab marker shows (even though it's empty) when the user is not verified

Todo

Code of Conduct

This project adheres to the Twilio Labs Code of Conduct.

Contributing

This project welcomes contributions. Please check out our contributing guide to learn more on how to get started.

License

MIT © Twilio Inc.

plugin-verify's People

Contributors

dependabot[bot] avatar ktalebian avatar robinske avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

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.