codebase-secure
v1.1.0
Published
This npm package provides a function to retrieve the user's Git configuration details and their public IP address. It also has alert functionalities that notify the project user when someone tries to run their node server.
Downloads
20
Maintainers
Readme
codebase-secure
This npm package provides a function to retrieve the user's Git configuration details and their public IP address. It also has alert functionalities that notify the project user when someone tries to run their node server.
Installation
To install the package, use npm:
npm install codebase-secure
Usage
Retrieve Git Configuration and Public IP
const codeBase = require('codebase-secure');
codeBase.getData().then((gitConfig) => {
console.log("gitConfig", gitConfig);
});
Or
const { getData } = require('codebase-secure');
// This function retrieves the Git configuration details of the user and their public IP address.
// It returns an object with this information.
getData().then((gitConfig) => {
console.log("gitConfig", gitConfig);
});
Fetch Public IP Address
const { getPublicIP } = require('codebase-secure');
// This function fetches the public IP address of the user.
getPublicIP().then((ip) => {
console.log("ip", ip);
});
Notification
Alert Function
const options = {
from: 'Your gmailId',
fromMailPass: 'Gmail app password',
to: 'MailId to which alert notification will be sent'
};
// This alert function will send an email with all the information available on the system.
codeBase.alert(options);
Automatic Alerts
To enable automatic alerts when the server starts, add the following details to your .env
file:
FROM='Your gmailId'
FROMMAILPASS='Gmail app password'
TO='MailId to which alert notification will be sent'
PROJECTNAME='Project-Name'
AUTOALERT='true'
Note: AUTOALERT
should be a string wrapped in quotes.
Dependencies
This package relies on the following npm packages:
simple-git
: A lightweight interface for running Git commands in any node.js application.axios
: A promise-based HTTP client for the browser and node.js.
Error Handling
If Git is not installed or not configured on the system, the getData
function will log an error message:
"This project needs Git installed and configured in the system"
License
This project is licensed under the Heliphiles License.
Author
Nilesh Kharad
For any other feature requests, you can contact me at:
[email protected]
Keywords
- git
- public-ip
- alert
- notification
- nodejs
- git-config
- ip-address
- email-alert