Requirements & Support

Requirements
Courier Account	Sign Up
Minimum iOS SDK Version	15.0
Minimum Android SDK Version	23

 

Installation

Using npm

npm install @trycourier/courier-react-native

Using yarn

yarn add @trycourier/courier-react-native

 

iOS

1. Support iOS 15.0+ in your Project

2. Support iOS 15+ in your Podfile

# Resolve react_native_pods.rb with node to allow for hoisting
require Pod::Executable.execute_command('node', ['-p'..

# Courier React Native requires iOS 15+
platform :ios, '15.0' // Add this line
prepare_react_native_project!

..

3. Install the Cocoapods

From the root of your React Native project run

cd ios && pod install

 

Android

1. Add the Jitpack repository

In your android/build.gradle make sure your build and repository values are as follows

buildscript {

    ext {

        // Double check these values
        buildToolsVersion = "33.0.0"
        minSdkVersion = 23
        compileSdkVersion = 33
        targetSdkVersion = 33
        ..
    }

    repositories {
        google()
        mavenCentral()
        maven { url 'https://www.jitpack.io' } // THIS LINE
    }

    ..

}

2. Run Gradle Sync

Your app must support at least gradle 8.4

 

3. Extend your MainActivity with CourierReactNativeActivity

This allows the Courier SDK to manage the current user between app sessions.

Java

import com.courierreactnative.CourierReactNativeActivity;

public class MainActivity extends CourierReactNativeActivity {
    ..
}

Kotlin

import com.courierreactnative.CourierReactNativeActivity;

class MainActivity : CourierReactNativeActivity() {
    ..
}

 

Getting Started

These are all the available features of the SDK.

	Feature	Description
1	Authentication	Manages user credentials between app sessions. Required if you would like to use Courier Inbox and Push Notifications.
2	Inbox	An in-app notification center you can use to notify your users. Comes with a prebuilt UI and also supports fully custom UIs.
3	Push Notifications	Automatically manages push notification device tokens and gives convenient functions for handling push notification receiving and clicking.
4	Preferences	Allow users to update which types of notifications they would like to receive.
5	CourierClient	The base level API wrapper around the Courier endpoints. Useful if you have a highly customized user experience or codebase requirements.

 

Expo

If you are using Expo, you should check out the Expo Docs for all the details.

 

Example Projects

Starter projects using this SDK.

Project Link
Example

 

Share feedback with Courier

We want to make this the best SDK for managing notifications! Have an idea or feedback about our SDKs? Let us know!

Courier React Native Issues