https://github.com/aptabase/aptabase-react-native

React Native SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps
https://github.com/aptabase/aptabase-react-native

analytics privacy react-native

Last synced: 14 days ago
JSON representation

React Native SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps

• Host: GitHub
• URL: https://github.com/aptabase/aptabase-react-native
• Owner: aptabase
• License: mit
• Created: 2023-05-26T20:59:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-14T03:19:00.000Z (6 months ago)
• Last Synced: 2025-01-16T18:25:43.105Z (23 days ago)
• Topics: analytics, privacy, react-native
• Language: TypeScript
• Homepage: https://aptabase.com
• Size: 728 KB
• Stars: 26
• Watchers: 1
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Aptabase](https://aptabase.com/og.png)

# React Native SDK for Aptabase

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

## Install

Install the SDK using `npm` or your preferred JavaScript package manager

```bash

npm add @aptabase/react-native

```

## Android Requirements

If you're targeting Android, you'll need to add the following permissions to your `AndroidManifest.xml`:

```xml

```

## Usage

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

Initialize the SDK by calling the `init` function before declaring your `App` component:

```js

import Aptabase from "@aptabase/react-native";

Aptabase.init(""); // 👈 this is where you enter your App Key

export default function App() {

  return ;

}

```

Afterwards, you can start tracking events with `trackEvent`:

```js

import { trackEvent } from "@aptabase/react-native";

import { useState } from "react";

export function Counter() {

  const [count, setCount] = useState(0);

  const increment = () => {

    setCount(count + 1);

    trackEvent("increment", { count });

  };

  const decrement = () => {

    setCount(count - 1);

    trackEvent("decrement", { count });

  };

  return (

    

      

      

      Count is {count}

    

  );

}

```

To disable tracking events, you can call the `dispose` function. This will stop and deinitalize the SDK.

```js

import Aptabase from "@aptabase/react-native";

Aptabase.dispose();

```

**Note for Expo apps:** Events sent during development while running on Expo Go will not have the `App Version` property because native modules are not available in Expo Go. However, when you build your app and run it on a real device, the `App Version` property will be available. Alternatively, you can also set the `appVersion` during the `init` call so that it's also available during development.

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

## Preparing for Submission to Apple App Store

When submitting your app to the Apple App Store, you'll need to fill out the `App Privacy` form. You can find all the answers on our [How to fill out the Apple App Privacy when using Aptabase](https://aptabase.com/docs/apple-app-privacy) guide.