Skip to content

sense-opensource/sense-user-activity-js

Repository files navigation

Sense User Activity JS

Welcome to Sense’s open source repository

### 🖱️ User Activity

Keystroke Scroll Touch Mouse Orientation

Sense is a client side library that enables you to identify users by pinpointing their hardware and software characteristics. This is done by computing a token that stays consistent in spite of any manipulation.

Getting started with Sense

Bash

    # Install all dependencies (including dev dependencies)
    npm install
    # or
    npm i

    # Run the playground locally
    npm run playground

    # Build the project and generate the dist folder
    npm run build

JS Integration

    // Include the Sense library 
    <script src="https://cdn.getsense.co/js/v1/senseos/sense-user-activity-js"></script>

    // 🔧 Initialise the Sense library
    SenseOS.initSenseBehaviour();

    // / 📍 This code monitors input fields that include the data-behaviour attribute.
    // Example: <input type="text" data-behaviour="name" />

    // 🧠 Get user behaviour data
    const behaviour = SenseOS.getBehaviour();

    // OR use destructuring to access specific metrics  -->
    const { keyStrokeData, mouseMovements, scrollMetrics } = Sense.getBehaviour();

Plug and play, in just 4 steps

1️⃣ Visit the GitHub Repository
2️⃣ Download or Clone the Repository. Use the GitHub interface to download the ZIP file, or run.
3️⃣ Run the Installer / Setup Script. Follow the setup instructions provided below.
4️⃣ Start Testing. Once installed, begin testing and validating the accuracy of the metrics you're interested in.

With Sense, you can

✅ Predict user intent : Identify the good from the bad visitors with precision
✅ Create user identities : Tokenise events with a particular user and device
✅ Custom risk signals : Developer specific scripts that perform unique functions
✅ Protect against Identity spoofing : Prevent users from impersonation
✅ Stop device or browser manipulation : Detect user behaviour anomalies

Resources

MIT license :

Sense OS is available under the MIT license

Contributors code of conduct :

Thank you for your interest in contributing to this project! We welcome all contributions and are excited to have you join our community. Please read these code of conduct to ensure a smooth collaboration.

Where you can get support :

Gmail [email protected]

Public Support:

For questions, bug reports, or feature requests, please use the Issues and Discussions sections on our repository. This helps the entire community benefit from shared knowledge and solutions.

Community Chat:

Join our Discord server (link) to connect with other developers, ask questions in real-time, and share your feedback on Sense.

Interested in contributing to Sense?

Please review our Contribution Guidelines to learn how to get started, submit pull requests, or run the project locally. We encourage you to read these guidelines carefully before making any contributions. Your input helps us make Sense better for everyone!