Skip to content

saketharshraj/email-authenticator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

E-Mail Solutions

All e-mail solution for your project. You can customize this project in your local.

API Reference

Send E-mail

  POST /api/v1/send-email
Parameter Type Description
id int Optional. Type of service
project string Required. Project name
email string Required. Recepient E-mail
subject string Required. E-mail Subject

By deafult id is set to 1 i.e OTP SERVICE.

Verify E-mail

  POST /api/v1/verify-email
Parameter Type Description
transid string Required. Transaction id
email string Required. E-mail that need to be verified
otp string Required. OTP of recepient E-mail

Run Locally

Clone the project

  git clone git remote add origin https://github.com/iot-lab-kiit/email-authenticator.git

Go to the project directory

  cd email-authenticator

Install dependencies

  yarn

Start the server

  yarn dev

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

Parameter Description
MONGO_URI MongoDB URL
EMAIL G-mail id of sender
PASSWORD G-mail App Password

Author

About

An open-source code for developers to integrate email authentication service in their backend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published