# audit-it

> Audit-it is a lightweight npm package that allows you to effortlessly track and visualize user activities on your website in a graphical format. With easy integration into your web applications, you can gain valuable insights into user engagement, behavio

Latest version **1.1.11** (published 2023-12-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install audit-it
pnpm add audit-it
yarn add audit-it
bun add audit-it
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.11 |
| Published | 2023-12-14 |
| First published | 2023-10-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Anoop sunitha |
| Maintainers | anoopsunitha |
| Keywords | web, audits, analytics |

## Links

- npm: https://www.npmjs.com/package/audit-it
- Repository: https://github.com/Anoopoo7/auditit
- Homepage: https://github.com/Anoopoo7/auditit#readme
- Issues: https://github.com/Anoopoo7/auditit/issues
- npm.io page: https://npm.io/package/audit-it

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.11 (latest) — 2023-12-14
- 1.1.10 — 2023-12-14
- 1.1.9 — 2023-12-14
- 1.1.8 — 2023-12-14
- 1.1.7 — 2023-12-14
- 1.1.6 — 2023-12-14
- 1.1.5 — 2023-12-14
- 1.1.4 — 2023-12-14
- 1.1.3 — 2023-12-14
- 1.1.2 — 2023-12-14
- 1.1.1 — 2023-12-14
- 1.0.2 — 2023-10-05
- 1.0.1 — 2023-10-04
- 1.0.0 — 2023-10-04

## README

<h1 align="center">
  <img src="https://i.ibb.co/wQ8W49W/audit-logo.png" alt="projct Logo" width="200">
  <br>
  <br>
  AUDIT IT
</h1>

<p align="center">
  <a href="https://github.com/Anoopoo7/auditit">
    <img src="https://img.shields.io/github/stars/Anoopoo7/auditit?style=for-the-badge" alt="GitHub stars">
  </a>
  <a href="https://github.com/Anoopoo7/auditit/issues">
    <img src="https://img.shields.io/github/issues/Anoopoo7/auditit?style=for-the-badge" alt="GitHub issues">
  </a>
  <a href="https://github.com/Anoopoo7/auditit/network">
    <img src="https://img.shields.io/github/forks/Anoopoo7/auditit?style=for-the-badge" alt="GitHub forks">
  </a>
  <a href="https://github.com/Anoopoo7/auditit/LICENSE">
    <img src="https://img.shields.io/github/license/Anoopoo7/auditit?style=for-the-badge" alt="GitHub license">
  </a>
</p>

<p align="center">
  <strong>Open-Source Web Auditing Services</strong>
  <br>
  <br>
  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
</p>

---

<p align="center">
  <img src="https://i.ibb.co/W0b0L6z/audit-it-image.png" alt="Project Screenshot">
</p>

---

## 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**](https://audit-admin.vercel.app)
and create pages and their curresponding events to record.


1. Insall on project:
```bash
npm instal audit-it
```
2. Import and call it Dom events: 
```bash
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
<br>

3. Customize the event and page: 
```bash
....
# 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);
}
.....
```

- For more information https://crosscodeblogs.netlify.app/blog/auditit

## License

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

## Acknowledgments

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

---

<p align="center">
  <a href="https://github.com/Anoopoo7">
    <img src="https://img.shields.io/badge/Visit%20My%20GitHub-Anoopoo7-333?style=for-the-badge&logo=github" alt="GitHub profile">
  </a>
</p>

---
_Source: https://npm.io/package/audit-it · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._