akash-ramjyothi / leak-master-email-api

Developed a Microservice Architecture based Emailing-API, to send an Alert notification email to the User (recipientEmail) with the current Server time. The purpose of this API is to send an email notifying the user that there has been a Gas Leak in his premises with an exact snapshot of the time of the Gas Leak.

Leak Master - Email API

📜 Description:

Developed a Microservice-based Emailing-API that excels in rapid response, dispatching Alert notification emails to recipients within just 5 seconds of gas leak detection. These emails contain a precise server time stamp, offering indisputable evidence for insurance, warranty claims, investigations, etc. Triggerable via Postman or other clients, it ensures swift integration. Presently, the Leak-Master application initiates this API through the Android App for quick gas leak notifications.

📽 Sample Demo:

Leak-Master.Email-API.Demo.mp4

🌎 Deployed Website:

https://leak-master-email-api.onrender.com/send-email

📱Leak Master App:

https://github.com/Akash-Ramjyothi/Leak-Master-App

🧠 Working of Project:

🏗 Built With:

• Node.JS
• Express
• NodeMailer
• Render to deploy
• Microservice Architecture
• Postman to test standalone API

🧪 Steps to Use:

• Clone the repo.
• Use npm install to install all required packages.
• Use node index.js to run the API continuously on port 3000 (by default)
• In Postman, make a POST request to the url https://localhost:3000/send-emailsend-email.
• Make sure to give the request Body as,

{
  "recipientName": "<Name>",
  "recipientEmail": "<Valid Gmail address>"
}

• Click on Send in Postman.
• Change POST URL to https://leak-master-email-api.onrender.com/send-email to use deployed API.

💥 How to Contribute?

• Take a look at the Existing Issues or create your own Issues!
• Wait for the Issue to be assigned to you after which you can start working on it.
• Fork the Repo and create a Branch for any Issue that you are working upon.
• Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
• Add Screenshots to help me know what this Code is all about.

👦 Developed By:

Akash Ramjyothi

               ☎️ PH:[phone].

🌐 References Used:

• https://www.youtube.com/watch?v=abw96dX-3bs
• https://www.youtube.com/watch?v=RnA4TdTGy5I
• https://www.youtube.com/watch?v=9zPZ9yJML6E
• https://www.youtube.com/watch?v=L46FwfVTRE0