audit-it

1.1.11 • Public • Published

projct Logo

AUDIT IT

GitHub stars GitHub issues GitHub forks GitHub license

Open-Source Web Auditing Services

Audit-It is a lightweight and open-source web analytics system built on Express.js and Algolia. Easily monitor user clicks on configured pages and visualize events on a centralized dashboard. Installation is simple with npm, and configuration allows seamless integration with your Express.js application. Empower your analytics with Audit-It!

Features


Project Screenshot


Features

  • Easy Installation: Get started quickly with npm install audit-it.
  • Flexible Configuration: Customize tracking for specific pages using a simple configuration file.
  • Centralized Dashboard: Monitor and analyze user events conveniently from a centralized dashboard.
  • Community Contributions: Open to contributions and improvements from the community.

Getting Started

You need to Sign in to Audit Admin Dashboard and create pages and their curresponding events to record.

  1. Insall on project:
npm instal audit-it
  1. Import and call it Dom events:
import record from "audit-it"

const MyComponent = () => {

    const handleTrigger = () => {
        #pass the event name 
        record("user_read_desc");
    }

    return (
        <Button onClick={handleTrigger} >click</Button>
    );
}

if you are not passing the event, then user will be anonymous andpage will take up from the current pathname

  1. Customize the event and page:
....
# changing the page name
const handleTrigger = () => {
    # passing event and page
    record("user_read_desc", "home_page");
}


# passing user info
const handleTrigger = () => {
    record("user_read_desc", userData?.email);
}
.....

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • Hat tip to anyone whose code was used.
  • Inspiration.
  • etc.

GitHub profile

Readme

Keywords

Package Sidebar

Install

npm i audit-it

Weekly Downloads

1

Version

1.1.11

License

MIT

Unpacked Size

4.63 kB

Total Files

3

Last publish

Collaborators

  • anoopsunitha