patch-man

             _       _
 _ __   __ _| |_ ___| |__        _ __ ___   __ _ _ __
| '_ \ / _` | __/ __| '_ \ _____| '_ ` _ \ / _` | '_ \
| |_) | (_| | || (__| | | |_____| | | | | | (_| | | | |
| .__/ \__,_|\__\___|_| |_|     |_| |_| |_|\__,_|_| |_|
|_|

&&

Bug Tracking Tool using NPM

Patch-Man is a package that provides alert notifications to your email when a bug arises in your code. It uses AWS Simple Email Service (SES) to send these notifications.

Usage Steps

To effectively utilize Patch-Man, follow these steps:

1. AWS SES Setup

Create an AWS SES secret key and client ID for email setup.

2. Environment Setup

Set up your .env file with the following variables:

• ProjectName: Your project's name.
• ClientId and SecretKey (AWS): Required for AWS SES setup.
• VerifiedMail (SES): Email address for receiving alerts.
• ToMails: Email addresses to receive alert mails.

3. Integration

Integrate Patch-Man into your project's routes directory. Call awsSES(error) within the exception catch block, passing the error as a parameter.

Note: Replace the repository name (sample_project) with your own repository. The repository provided is for demonstration purposes only.

Installation

const patch-hman = require('patch-man')

Sample code

try {
  // Your code that might throw an error
  const result = 10 / 0;
} catch (error) {
  // Using patch-man function to report the error
  patchMan.awsSES(error);
}