Skip to content

iarthstar/ms-otp-email

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Micro Service : OTP Email

This microservice is meant to be used for generating an One Time Password (OTP) for a valid email, a mail is then sent to the said email using a email service provider (i.e. gmail), and later, also to verify the received OTP against the given email.

This microservice is build using template Grandeur Backend. It uses Redis as a data store.

Links

APIs

Base URL

KEY VALUE
HOST Environment Link
API /otp_email_api

Endpoints

NAME METHOD ENDPOINT BODY
Generate OTP POST /generate { "email: "iarthstar@gmail.com" }
Verify OTP POST /verify { "otp": 123456, "email": "iarthstar@gmail.com"}

Development Guide

NOTE : Please make sure you have yarn :: Installing yarn

  • Initial setup
$ yarn install
  • To watch for changes
$ nodemon

Deployment Guide

NOTE : Hosted using Heroku, Continuous Deployment using it for below branches.