locallytics

locallytics is a lightweight, framework-agnostic analytics runtime. This release currently supports SQLite.

Install

npm install locallytics better-sqlite3

Quickstart

Create one shared Locallytics instance.

import { createLocallytics } from "locallytics";
import Database from "better-sqlite3";

export const locallytics = createLocallytics({
  database: new Database("database.sqlite"),
  sessionTracking: true,
});

Track custom events.

await locallytics.track("button_click", { button: "cta" });

Read stored events.

const events = await locallytics.listEvents({ limit: 25 });

API

• createLocallytics(config)
• locallytics.track(type, metadata?)
• locallytics.trackPageView(route?)
• locallytics.listEvents(options?)
• locallytics.setUserId(userId)
• locallytics.getUserId()
• locallytics.getSessionId()

CLI

Use @locallytics/cli to generate and run migrations:

npm install -D @locallytics/cli
npx locallytics generate
npx locallytics migrate