Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDKs
/

Install the React Native SDK

On this page

  • Prerequisites
  • Use the SDK with Expo
  • Install the SDK in a Bare React Native App
  • Create a React Native Project
  • Install the SDK with npm
  • Enable Hermes
  • Resolve CocoaPods Dependencies
  • Extend Android Proguard Configuration
  • Enable TypeScript (recommended, but optional)
  • Install the @realm/react Library
  • Run the App
  • Create a React Native Project
  • Install the SDK Using NPM
  • Link the SDK's Native Module
  • Confirm the Link Step (Android)
  • Enable TypeScript (optional)
  • Run the App
  • Import the SDK

The Atlas Device SDK for React Native enables development of React Native applications using the JavaScript and TypeScript languages. React Native enables you to build cross-platform iOS and Android apps with a single codebase using the React framework.

Prerequisites

Before getting started, ensure your development environment meets the following prerequisites. These are required for the latest version of the React Native SDK:

Note

Realm JS v10.6.0 and Later Support Mac Catalyst

For React Native version 0.64 and below, you must take additional steps to build your application when using Mac Catalyst.

Use the SDK with Expo

You can use the React Native SDK with a bare React Native app or Expo. This page and the React Native SDK documentation generally assume that you're using a bare React Native app and not Expo.

If you want to use the React Native SDK with Expo, check out the Bootstrap with Expo page.

Install the SDK in a Bare React Native App

Select the tab below that corresponds to your React Native version. Follow the steps to create a React Native project and add the React Native SDK to it.

Tip

Atlas Device SDK and Realm

The SDK uses Realm Core database for device data persistence. When you install the React Native SDK, the package names reflect Realm naming.

Import the SDK

Add the following line to the top of your source files where you want to use the SDK:

import Realm from "realm";
← 
 →

On this page