Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 2.13 KB

README.md

File metadata and controls

74 lines (56 loc) · 2.13 KB
Raw

OTP by Email for Vlocity OmniScript

Simple OTP by Email for embedding into OmniScripts.

Overview

This is a node.js app generating a one time passcode and sending by Email using nodemailer. The intent for this app is to be used in a Vlocity OmniScript for user acknowledgement of document reviews. Current support for app runtime is local and Heroku only.

Node version is specified but you may change from the package.json. Build artifacts are ignored by version control using .gitignore. OmniStudio tools are available in the omnistudio folder.

Prerequisites

We assume that you have:

  1. Node.js and npm installed.
  2. a free Heroku account.
  3. the Heroku CLI.
  4. Add https://otp-by-email.herokuapp.com to the Salesforce Remote Site URLs.

Running OTP by Email

1. Setup your local project

# Clone this project onto your machine
git clone https://github.com/ThomasSmithIRE/otp_omniscript.git

# Change into the project
cd otp_omniscript/

# Install the dependencies
npm install

2. Run locally

heroku local web

Your app should now be running on http://localhost:5000/.

3. Create your Heroku app

Note: You need to deploy your local source code to Github before creating the Heroku app.

git add .
git commit -m "Added a Procfile."
heroku login
heroku create

4. Deploy to Heroku

git push heroku main

4. Open Heroku app

heroku open

Contributing

Issues and questions

Found a bug or have a question about this project? We'd love to hear from you!

  1. Browse to ThomasSmithIRE/otp_omniscript/issues
  2. Create a new issue
  3. Select the [x] examples category

See you there and thanks for helping to improve OTP by Email for everyone!