sentinel-guard.js

sentinel-guard.js is a JavaScript package designed for bot detection and browser fingerprinting, optimized for use in React applications. This package includes functionality to detect bots and generate unique IDs using advanced fingerprinting techniques.

Installation

You can install sentinel-guard.js from npm in your React project using the following command:

npm install sentinel-guard.js

or if you are using Yarn:

yarn add sentinel-guard.js

Usage

Importing the Package

To use sentinel-guard.js in your React application, import the functions as follows:

import { botDetector, browserFingerprints } from 'sentinel-guard.js';

Example

Here’s an example of how to use the botDetector and browserFingerprints functions in a React component:

import React, { useEffect, useState } from 'react';
import { botDetector, browserFingerprints } from 'sentinel-guard.js';

const App = () => {
  const [botDetectionResult, setBotDetectionResult] = useState(null);
  const [uniqueId, setUniqueId] = useState('');

  useEffect(() => {
    const detectBot = async () => {
      try {
        const result = await botDetector();
        setBotDetectionResult(result);
      } catch (error) {
        console.error('Error detecting bot:', error);
      }
    };

    detectBot();
    setUniqueId(browserFingerprints());
  }, []);

  return (
    <div>
      <h1>Bot Detection and Unique ID Generator</h1>
      <p>Bot Detection Result: {JSON.stringify(botDetectionResult)}</p>
      <p>Generated Unique ID: {uniqueId}</p>
    </div>
  );
};

export default App;

Running the Example Project

To run the example project included in the repository, follow these steps:

1. Navigate to the Example Folder:

   cd example

2. Install Dependencies:

   If you are using npm:

   npm install

   or if you are using Yarn:

   yarn install

3. Start the Development Server:

   To start the React development server, run:

   If you are using npm:

   npm start

   or if you are using Yarn:

   yarn start

   This will open the example project in your default web browser, and you can see the package in action.

Dependencies

sentinel-guard.js relies on the following libraries:

• ThumbmarkJS: A library for creating unique fingerprints of browser sessions.

  • package

• @fingerprintjs/botd: A library for detecting bots using fingerprinting technology.

  • package

Credits

This package utilizes the following external packages:

• ThumbmarkJS: @thumbmarkjs/thumbmarkjs
• @fingerprintjs/botd: @fingerprintjs/botd

License

sentinel-guard.js is licensed under the MIT License.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your improvements or bug fixes.

Contact

For any questions or feedback, please reach out to Ganesh Suthar.