About this project

This package provides an SDK for integrating Aptabase analytics into Electron desktop applications. Aptabase is described as an open source, privacy-first, simple analytics platform for mobile, desktop, and web apps. Installation is done via npm: npm add @aptabase/electron Initialization occurs in the Electron main process before the app ready event, passing your App Key obtained from the Aptabase dashboard. Event tracking uses a trackEvent function imported from either @aptabase/electron/renderer for renderer process events or @aptabase/electron/main for main process events. Events can be tracked with or without custom properties, which must be strings or numbers. The SDK automatically enriches events with OS, app version, and other useful metadata. The SDK does not auto-track any events; developers must manually call trackEvent wherever they want data captured. Calling trackEvent at startup is recommended. The trackEvent function runs asynchronously in the background and does not require awaiting. For AI/LLM integration guidance, the repository references an llms.txt file.