npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

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