https://github.com/encodeopl/userwave

NPM package which allows to track user activity with self-hosted dashboard
https://github.com/encodeopl/userwave

buildinpublic http-server js npm open-source package-development self-hosted ts

Last synced: 3 months ago
JSON representation

NPM package which allows to track user activity with self-hosted dashboard

• Host: GitHub
• URL: https://github.com/encodeopl/userwave
• Owner: Encodeopl
• License: mit
• Created: 2024-11-06T22:36:32.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-06T23:11:02.000Z (3 months ago)
• Last Synced: 2024-11-06T23:31:36.679Z (3 months ago)
• Topics: buildinpublic, http-server, js, npm, open-source, package-development, self-hosted, ts
• Homepage:
• Size: 0 Bytes
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# UserWave

[![NPM Version](https://img.shields.io/npm/v/userwave)](https://www.npmjs.com/package/userwave)

[![License](https://img.shields.io/npm/l/userwave)](LICENSE)

[![Build Status](https://img.shields.io/github/workflow/status/encodeopl/userwave/CI)](https://github.com/encodeopl/userwave/actions)

**UserWave** is an open-source JavaScript library for tracking user activity on websites or web applications. With **UserWave**, you can capture and analyze interactions like button clicks, form submissions, and other events to better understand user behavior and improve your product experience. **UserWave** is built in public, and you can contribute or follow the development on [GitHub](https://github.com/yourusername/userwave).

## Table of Contents

- [Features](#features)

- [Installation](#installation)

- [Contributing](#contributing)

- [License](#license)

## Features

- **Event Tracking**: Track specific events like button clicks, form submissions, and more.

- **Timestamped Logs**: Log each event with the exact time it occurred.

- **Custom Event Names**: Name and categorize events for easier analysis.

- **Real-time Event Stream**: View user interactions in real-time (Pro feature).

- **Automatic Page View Tracking**: Automatically captures page views without manual setup.

- **Minimal Setup**: Simple to install and start tracking with minimal configuration.

- **Data Privacy First**: No personally identifiable information (PII) is stored by default.

## Installation

Install **UserWave** via npm:

```bash

npm install userwave

```

## Contributing

UserWave is an open-source project built in public! Contributions are welcome. To contribute:

- Fork the repository.

- Create a new branch with your feature or bugfix.

- Submit a pull request with a detailed description.

- Please review our contributing guidelines before submitting.

License

This project is licensed under the MIT License. See the LICENSE file for details.