Analytics Tracker Package

A TypeScript-based analytics tracking package with automatic configuration for web applications. This package provides an easy way to track and analyze user interactions in your applications.

Features

• Easy application registration through CLI
• Automatic API key generation
• MongoDB integration for data storage
• TypeScript support
• Simple tracking initialization

Installation

npm install analytics-tracker-package
# or
yarn add analytics-tracker-package
# or
pnpm add analytics-tracker-package

Setup

After installation, the package will automatically run the setup process. If you need to run it manually, you can use:

npm run setup
# or
yarn setup
# or
pnpm setup

During setup, you'll be prompted to:

1. Enter your application name
2. The system will automatically generate an API key for your application

Usage

After completing the setup, you can start using the tracker in your application:

import { Tracker } from 'analytics-tracker-package';

const tracker = new Tracker({
  apiKey: 'your-api-key',
  appName: 'your-app-name'
});

await tracker.initialize();

API Reference

Tracker Configuration

interface TrackingConfig {
  apiKey: string;      // Your application's API key
  appName: string;     // Your application name
  endpoint?: string;   // Optional custom endpoint
}

Application Registration

interface AppRegistration {
  appName: string;     // Application name
  apiKey: string;      // Generated API key
  endpoint: string;    // API endpoint
  createdAt: Date;     // Registration date
  active: boolean;     // Application status
}

Event Tracking

interface TrackingEvent {
  type: string;                    // Event type
  timestamp: number;               // Event timestamp
  data: Record<string, any>;       // Event data
}

Development

Prerequisites

• Node.js (v14 or higher)
• npm, yarn, or pnpm
• MongoDB database

Building

npm run build

Testing

npm run test

Linting

npm run lint

License

MIT

Author

Auratech Team