README.md

Electron SDK for Aptabase

Instrument your Electron apps with Aptabase, an Open Source, Privacy-First, and Simple Analytics for Mobile, Desktop, and Web Apps.

Install

Install the SDK using your preferred JavaScript package manager

npm add @aptabase/electron

Usage

First, you need to get your App Key from Aptabase, you can find it in the Instructions menu on the left side menu.

On your Electron main's process, initialize the SDK before the app is ready:

import { initialize } from "@aptabase/electron/main";

initialize("<YOUR_APP_KEY>"); // 👈 this is where you enter your App Key

app.whenReady().then(() => {
  // ... the rest of your app initialization code
});

Afterward, you can start tracking events with trackEvent:

import { trackEvent } from "@aptabase/electron/renderer";

trackEvent("app_started"); // An event with no properties
trackEvent("screen_view", { name: "Settings" }); // An event with a custom property

NOTE: The trackEvent function is available under separate import paths, depending on where you want to track the event from.

• import from @aptabase/electron/renderer to track events from the renderer process
• import from @aptabase/electron/main to track events from the main process

The instruction above is recommended for modern setups of Electron. For older versions of Electron, please refer to the alternative instructions.

A few important notes:

1. The SDK will automatically enhance the event with some useful information, like the OS, the app version, and other things.
2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call trackEvent manually.
   • Because of this, it's generally recommended to at least track an event at startup
3. You do not need to await for the trackEvent function, it'll run in the background.
4. Only strings and numbers values are allowed on custom properties