react-native-analytics-debugger/README.md

The Avo react-native debugger

![https://www.avo.app](https://firebasestorage.googleapis.com/v0/b/avo-frontpage.appspot.com/o/logo%2Fassets%2Favo.png?alt=media&token=2acfd7bd-2faf-4787-a450-8f99c407a483)

The Avo React Native debugger enables you to easily see which analytics events are being sent from your app. Two display modes are provided, **bar** and **bubble**:

#### Bar

![Bar mode](https://firebasestorage.googleapis.com/v0/b/avo-frontpage.appspot.com/o/misc%2Fbar.png?alt=media&token=7436a32d-907d-495e-8a95-e00f67153aa5)

#### Bubble

![Bubble mode](https://firebasestorage.googleapis.com/v0/b/avo-frontpage.appspot.com/o/misc%2Fbubble.png?alt=media&token=757d4890-bf60-44cc-a576-d312230d5f79)

## Install

To install the latest version of Avo React Native analytics debugger, run this command:
#### with npm
```
npm install react-native-analytics-debugger
```

#### with yarn
```
yarn add react-native-analytics-debugger
```

## Setup

1. Import
```
import AvoDebugger from 'react-native-analytics-debugger'
```

2. Pass the AvoDebbuger into Avo
  * if using `initAvo`

    ```
    initAvo({env: 'dev', debugger: AvoDebugger})
    ```


  * if using `validateAvoEvent`

    ```
    validateAvoEvent({eventName, eventProperties, userProperties, env, debugger: AvoDebugger})
    ```

3. Enable the debugger
```
AvoDebugger.showDebugger({mode: 'bar' // or 'bubble'})
```

4. Disable the debugger
```
AvoDebugger.hideDebugger()
```

5. Sending custom events
```
AvoDebugger.post(Date.now(), "Test Event", [{id:"id0", name:"prop 0 name", value:"val 0"}, {id:"id1", name:"prop 1 name", value:"val 1"}], [{propertyId:"id0", message:"error in prop 0 with id0"}]);
```

## Caught a Bug?

Thank you, you are precious to us :hug: Please send an email to friends@avo.app or file an issue here on GitHub.

## Developing

Install all dependencies with `yarn install`. `yarn test -u` to run the tests and update the snaphsots.

## How to Create a Release

```
npm run release-it
```