@mrkc2303/tracku-sdk

TrackU SDK is a cutting-edge analytics tool designed to track user activities across web3 and web2 applications seamlessly. Leveraging on-chain edge functions provided by Fleek, this SDK offers reduced latency, minimized overhead, auto-scaling capabilities, cost-effective pricing, and self-sovereignty. Our goal is to bridge the gap between web3 and web2 ecosystems, providing all applications with the robust benefits of web3 infrastructure.

By providing a comprehensive, secure, and scalable solution, we empower developers and businesses to leverage the full potential of web3 infrastructure while gaining invaluable insights into their user base. Join us in bringing the future of analytics to the present, and enjoy the myriad benefits that TrackU offers.

This SDK can be used to track user interactions, page views, custom events, errors, and performance metrics.

➤ Installation

 npm install @mrkc2303/tracku-sdk

➤ Initialization

import TrackU from '@mrkc2303/tracku-sdk';

const apiKey = 'YOUR_API_KEY';
const projectId = 'YOUR_PROJECT_ID';

const trackingSDK = new TrackU(apiKey, projectId);

➤ Methods

setUser(userId, userDetails)

Sets the user ID and user details for tracking purposes. This should be called when a user logs in or when you have user information to track.

trackingSDK.setUser('USER_ID', {
  name: 'John Doe',
  email: '[email protected]'
});

endSession()

Ends the current user session and tracks the session duration.

trackingSDK.endSession();

setupPageViewTracking()

Tracks a page view, including the current URL and document title.

trackingSDK.setupPageViewTracking();

setupInteractionTracking()

Sets up tracking for user interactions such as clicks and scrolls. This method also sends heatmap data when the user unloads the page.

trackingSDK.setupInteractionTracking();

setUpCustomEvent(eventName, properties)

Tracks a custom event with the specified name and properties.

trackingSDK.setUpCustomEvent('custom_event', {
  property1: 'value1',
  property2: 'value2'
});

setUpErrorAndPerformanceEvent()

Sets up tracking for JavaScript errors and performance metrics.

trackingSDK.setUpErrorAndPerformanceEvent();

➤ Example

Here’s an example of how to use the TrackU SDK in a React application:

import React, { useEffect } from 'react';
import TrackU from '@mrkc2303/tracku-sdk';

function App() {
  useEffect(() => {
    const apiKey = 'YOUR_API_KEY';
    const projectId = 'YOUR_PROJECT_ID';
    const trackingSDK = new TrackU(apiKey, projectId);

    trackingSDK.setUser('USER_ID', { name: 'John Doe' });
    trackingSDK.setupPageViewTracking();
    trackingSDK.setupInteractionTracking();
    trackingSDK.setUpErrorAndPerformanceEvent();

    return () => {
      trackingSDK.endSession();
    };
  }, []);

  return (
    <div className="App">
      <header className="App-header">
        <h1>Welcome to TrackU</h1>
      </header>
    </div>
  );
}

export default App;