Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.77 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.77 KB
Raw

@leanplum/react-native-sdk

If you have already installed Node on your system, make sure it is Node 8.3 or newer.

Getting started using npm registry

Inside the React Native App

  1. $ yarn add @leanplum/react-native-sdk or $ npm install @leanplum/react-native-sdk

Autolinking

If you are using ReactNative 0.60 or greater, autolinking is supported by default. On Android gradle will take care of dependencies, for iOS only one command needs to be run to pull dependencies

$ cd ios && pod install

Manual linking

If you are using ReactNative without support for autolinking (versions before 0.60) than you'll have to link manually by executing:

$ npx react-native link @leanplum/react-native-sdk

and running pod install for iOS

$ cd ios && pod install

Documentation

Please refer to https://docs.leanplum.com/reference#leanplum-sdk-setup for iOS or Android configuration and more usages

Push notifications

Please refer to: https://github.com/react-native-community/react-native-push-notification-ios

Usage

import {Leanplum, LeanplumInbox} from '@leanplum/react-native-sdk';



// enable the below line only for development
// Leanplum.setAppIdForDevelopmentMode('APP_ID', 'DEVELOPMENT_KEY');

// use this in production
Leanplum.setAppIdForProductionMode('APP_ID', 'PRODUCTION_KEY');

Leanplum.start();
const inbox = await LeanplumInbox.inbox();

Local development

  1. Install yarn global $ npm install -g yarn

  2. Install dependencies for generating builds $ yarn install

  3. Build the sdk and publish it for local development purposes $ yarn local-publish

Inside the React Native App repository

  1. Add this sdk build to the app: $ npx yalc add @leanplum/react-native-sdk
  2. $ npx react-native link @leanplum/react-native-sdk