Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Latest commit

 

History

History
127 lines (84 loc) · 4 KB

README.md

File metadata and controls

127 lines (84 loc) · 4 KB
Raw

Nucleus.sh Desktop SDK

Nucleus.sh

Nucleus currently works with Electron and Tauri. If you'd like us to support another desktop framework, send us an email to [email protected].

Table of Contents

  1. Getting Started
  2. Usage
  3. How to Contribute

Getting Started

To get started with Nucleus, create an account at Nucleus and grab the App ID, then use the SDK to start tracking events.

Installation

As NPM package (recommended)

# with npm
npm install nucleus-analytics

# or with yarn
yarn add nucleus-analytics

Usage

import Nucleus from 'nucleus-analytics';

Nucleus.init('YOUR_APP_ID');

Replace 'YOUR_APP_ID' with the unique ID of your app. You can get it here.

You can check examples with different frameworks here.

API

Nucleus supports passing the following options as second argument to the Nucleus.init() method:

Nucleus.init('APP_ID', {
  endpoint: 'wss://app.nucleus.sh', // only option, we don't allow self hosting yet :(
  disableInDev: true, // disable in development mode. We recommend not to call
                      // `init` method, as that will be more reliable.
  debug: false, // if set to `true`, will log a bunch of things.
  disableTracking: false, // will not track anything. You can also use `Nucleus.disableTracking()`.
                          // note that some events will still be added to the queue, so if you call
                          // Nucleus.enableTracking() again, they will be sent to the server.
  automaticPageTracking: true, // will track all page changes.
  reportInterval: 2 * 1000, // at which interval the events are sent to the server.
  sessionTimeout: 60 * 30 * 1000, // time after which the session is ended
  cutoff: 60 * 60 * 48 * 1000, // time after which event that were not sent yet are deleted
  disableErrorReports: false, // wether to disable error tracking
})

Tracking

Track events with optional custom data

Nucleus.track("click", { foo: 'bar' });

Error Tracking

Track errors with a name and the Error object.

Nucleus.trackError(name, error);

By default Nucleus will listen for window.onerror and window.onunhandledrejection events and send them to the API. If you want to disable this behaviour, you can set disableErrorReports to true:

Nucleus.init('APP_ID', { disableErrorReports: true })

User Identification

Identify a user by a unique ID and optionally set custom properties.

Nucleus.identify('04f8846d-ecca-4a81-8740-f6428ceb7f7b', { firstName: 'Brendan', lastName: 'Eich' });

Page Tracking

Track page views with the page name and optional parameters. If the page name is not provided, the current window's pathname is used.

Nucleus.page('/about', { foo: 'baz' });

By default, Nucleus will track any page change by polling the url every 50 ms. If you prefer to manually track page changes, set automaticPageTracking to false and call Nucleus.page() on every page change.

Disabling Tracking

To disable tracking

Nucleus.disableTracking();

Enabling Tracking

To enable tracking

Nucleus.enableTracking();

How to Contribute

We're always looking for contributions from the community. Here's how you can help:

  1. Report Bugs: Create an issue report detailing the bug you've found.
  2. Suggest Features: Have a great idea for Nucleus? Don't hesitate to put it forward by creating an issue.
  3. Submit Pull Requests: Feel free to fix a bug or add a new feature and create a pull request. Make sure to follow the existing code style, and write clear commit messages explaining your changes.