Skip to content

Latest commit

 

History

History
170 lines (116 loc) · 7.72 KB

README.md

File metadata and controls

170 lines (116 loc) · 7.72 KB
Raw

@snowplow/react-native-tracker

actively-maintained Build Status License

Release RN version downloads

Snowplow is a scalable open-source platform for rich, high quality, low-latency data collection. It is designed to collect high quality, complete behavioral data for enterprise business.

To find out more, please check out the Snowplow website and our documentation.

Snowplow React-Native Tracker Overview

The Snowplow React Native Tracker allows you to add analytics to your React Native apps when using a Snowplow pipeline.

With this library you can collect granular event-level data as your users interact with your React Native applications. It is build on top of Snowplow's Mobile Native iOS and Android Trackers, in order to support the full range of out-of-the-box Snowplow events and tracking capabilities.

Quick start

From the root of your React Native project:

npm install --save @snowplow/react-native-tracker
npx pod-install

In your ios/Podfile file (unless using Expo Go), please add the FMDB dependency with modular_headers set to true. This is necessary to make the FMDB package generate module maps so that it can be used by the tracker:

pod 'FMDB', :modular_headers => true

Then, instrument the tracker in your app and start tracking events. For example:

import { createTracker } from '@snowplow/react-native-tracker';

const tracker = createTracker(
    'my-namespace',
    { endpoint: 'https://my-collector.endpoint' }
);

tracker.trackScreenViewEvent({ name: 'myScreenName' });

The Snowplow React Native Tracker also provides first-class support for TypeScript, as it is fully typed.

See also our DemoApp for an example implementation.

Find out more

Technical Docs Setup Guide
i1 i2
Technical Docs Setup Guide

Maintainer quick start

Assuming a react-native environment is set up, from the root of the repository:

yarn

Unit tests

To run the unit tests, simply execute:

yarn test

Launching the example app

Replace "placeholder" with the URI for your Snowplow Mini or other Snowplow collector in DemoApp/App.js.

For Android:

yarn example android

Note: Linux users who want to run the DemoApp for Android, would also need to run yarn start in a separate terminal.

For iOS:

yarn example ios

End-to-end tests

Snowplow React-Native Tracker is being end-to-end tested using Snowplow Micro and Detox. To run these tests locally:

Testing

  1. Start your Snowplow Micro instance locally.
  2. Replace the placeholder value for the collectorEndpoint variable in example/src/App.js (use the network IP address of your computer or ngrok).
  3. Start the end-to-end tests:
    • On Android, run yarn e2e:android
    • On iOS, run yarn e2e:ios

Contributing

Feedback and contributions are welcome - if you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our discourse forum.

Contributing
i3
Contributing

Copyright and license

The Snowplow React Native Tracker is copyright 2020-present Snowplow Analytics Ltd, 2019 DataCamp.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.