Carter-Analytics-Node-SDK

Local Development: Prerequisites

Tools

You will need the following things properly installed on your computer.

• Git
• Node.js

Usage

Install packages

yarn install

To start the library in the dev mode

yarn dev

and visit http://localhost:5173

To build the library

yarn build

To run the linter

yarn lint

To format the files

yarn format

To run all the tests

yarn test:run

To run all the tests with coverage

yarn test:coverage

Usage Documentation

Introduction:

TO BE ADDED

Installation:

To install the SDK in your Node.js project, you can use npm:

npm install carter-analytics-node-sdk

Initialization:

To initialize SDK, you need to provide configuration options. These options include your client_id and any additional settings required for analytics tracking. Initialize the SDK as shown below:

import { CarterAnalytics } from 'carter-analytics-node-sdk';

const analytics = new CarterAnalytics();
analytics.initialize([
  {
    client_id: "your GA measurement id",
    options: {
      /* Define your options */
    },
  },
  // Add more configurations if needed
]);

Publishing Events:

Once initialized, you can publish events to track user interactions, application usage, and other relevant activities. Use the publish method to send events to ShyftCA. Here's how you can publish an event:

analytics.publish({
  event: "example_event",
  event_properties: {
    /* Define event properties */
  },
  user_properties: {
    user_id: "user123",
    /* Define user properties */
  }
});

Event Structure:

• event: The label for the event being tracked. It could be a predefined event or a custom event defined by you.
• event_properties: Optional. Additional properties associated with the event, providing more context or details.
• user_properties: Information about the user associated with the event. It must include the user_id property, and you can include other custom properties as needed.

Additional Meta Parameters:

During the initialization of the SDK session the library automatically sets additional meta parameters and attaches them to each event published. These meta parameters include session information, user location, device details, timestamp, and referrer.

Example: Here's a complete example demonstrating how to use ShyftCA SDK in a Node.js application:

import ShyftCA from 'carter-analytics-node-sdk';

// Initialize ShyftCA SDK
analytics.initialize([
  {
    client_id: "your GA measurement id",
    options: {
      /* Define your options */
    },
  },
]);

// Publish events
analytics.publish({
  event: "example_event",
  event_properties: {
    /* Define event properties */
  },
  user_properties: {
    user_id: "user123",
    /* Define user properties */
  }
});