https://github.com/kunal-jaiswal972/livetrackjs

https://github.com/kunal-jaiswal972/livetrackjs

expressjs mongodb mongoose nodejs npm reactjs redis shadcn-ui socket-io tailwindcss vite websockets

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kunal-jaiswal972/livetrackjs
• Owner: Kunal-jaiswal972
• Created: 2024-08-23T12:01:14.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T13:13:31.000Z (2 months ago)
• Last Synced: 2024-10-09T18:04:53.149Z (about 1 month ago)
• Topics: expressjs, mongodb, mongoose, nodejs, npm, reactjs, redis, shadcn-ui, socket-io, tailwindcss, vite, websockets
• Language: JavaScript
• Homepage: https://live-track-js.vercel.app
• Size: 932 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LiveTrack React

This package allows you to track live users on your website and display them using a widget.

## Installation

```bash

npm install livetrack-react

```

## Getting Started

1. Go to [Live Track JS](https://live-track-js.vercel.app/) to create an account and get your API key.

## Usage

To integrate the live tracking widget into your React app:

1. **Wrap your app with the `LiveTrackProvider` and include the css file and `LiveUsersWidget` component:**

```jsx

import { LiveTrackProvider, LiveUsersWidget } from "livetrack-react";

import "livetrack-react/style.css";

function App() {

  return (

    

      

    

  );

}

export default App;

```

Replace `"your-api-key"` with the API key provided in dashboard.

2. Now, when users visit your website, they will be able to see live user activity displayed via the `LiveUsersWidget` component.

   ![Live Track Widget](https://imgur.com/Nceyps1.png)

3. You can also use the "useLiveUsers" hook to make a customizable widget of your choice.

```jsx

import { useLiveUsers } from "livetrack-react";

export const widget =()=> {

  return (

    const {liveUsers, isLoading, error} = useLiveUsers();

    //your custom widget goes here...

  );

}

```

4. You can track the activities on your sites through the [dashboard](https://live-track-js.vercel.app/)

## Features

- **Real-time User Tracking**: Instantly see how many users are active on your site.

- **Simple Integration**: Add the widget with just a few lines of code.

- **Customizable**: Modify thw widget to your design.

## Github

- Go to [Live Track JS](https://github.com/Kunal-jaiswal972/LiveTrackJS/) to know more.