このプロジェクトについて

このパッケージは、ElectronデスクトップアプリケーションにAptabaseの分析機能を統合するためのSDKです。Aptabaseは、モバイル、デスクトップ、Webアプリ向けのオープンソース・プライバシーファースト・シンプルな分析プラットフォームとして紹介されています。 インストールはnpmにて実施します: npm add @aptabase/electron 初期化はElectronのmainプロセスで行い、app readyイベントの前に実行し、Aptabaseダッシュボードから取得したApp Keyを渡します。 イベント追跡は、rendererプロセスのイベントには@aptabase/electron/rendererから、mainプロセスのイベントには@aptabase/electron/mainからインポートしたtrackEvent関数を使用します。カスタムプロパティ付き・なしのどちらでもイベントを追跡でき、カスタムプロパティは文字列または数値である必要があります。SDKは自動的にOS、アプリバージョン、その他の有用なメタデータをイベントに付加します。 このSDKはイベントを自動追跡しないため、開発者がデータ収集したい箇所で手動でtrackEventを呼び出す必要があります。起動時にtrackEventを呼び出すことが推奨されます。trackEvent関数はバックグラウンドで非同期実行され、awaitする必要はありません。 AI/LLM統合に関するガイドについては、リポジトリのllms.txtファイルを参照してください。