Install Realm for React Native
On this page
- Overview
- Prerequisites
- Installation
- Create a React Native Project
- Install Realm with npm
- Enable Hermes (optional)
- Resolve CocoaPods Dependencies
- Enable TypeScript (optional)
- Install the Realm React Library
- Run the App
- Create a React Native Project
- Install Realm Using NPM
- Link the Realm Native Module
- Confirm the Link Step (Android)
- Enable TypeScript (optional)
- Run the App
- Import Realm
Overview
The Realm React Native SDK 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:
Follow the official React Native CLI Quickstart instructions to set up your environment.
React Native v0.64.0 or later. Please consult the compatibility chart to determine which version of Realm is compatible.
Important
Using Realm with Expo
Expo now supports Realm with the Expo SDK version 44. To use Realm with Expo, upgrade to Expo SDK version 44. Consult the compatibility chart to determine which version of the Expo SDK is compatible Realm.
Note
Realm JS version 10.6.0 Supports Mac Catalyst
For React Native version 0.64 and below, building your Realm React Native application requires additional steps in order to build your application when using Mac Catalyst.
Installation
Select the tab below that corresponds to your React Native version. Follow the steps to create a React Native project and add the Realm React Native SDK to it.
Import Realm
Add the following line to the top of your source files where you want to use Realm:
import Realm from "realm";