Realm is a mobile database that runs directly inside phones, tablets or wearables. This project hosts the JavaScript versions of Realm. Currently we only support React Native (both iOS & Android) and Node.js (on MacOS and Linux) but we are considering adding support for Cordova/PhoneGap/Ionic as well.
Please see the detailed instructions in our docs to use Realm Javascript.
The documentation can be found at realm.io/docs/javascript/latest.
The API reference is located at realm.io/docs/javscript/latest/api.
In case you don't want to use the precompiled version on npm, you can build Realm yourself from source. You’ll need an Internet connection the first time you build in order to download the core library.
Prerequisites:
First clone this repository:
git clone https://github.com/realm/realm-js.git
Then in the cloned directory:
git submodule update --init --recursive
To build for iOS:
react-native/ios/RealmReact.xcodeprojRealmReact.framework as the build targetTo build for Android:
cd react-native/android./gradlew publishAndroid<project-root>/androidTo build for nodejs:
npm install --build-from-source
On Windows you will need to setup the environment for node-gyp
Option 1: Install windows-build-tools node package
Open an elevated command prompt (As Administrator)
npm install -g --production windows-build-tools
Option 2: Manually install and configure
You can use scripts/tests.sh to run the various tests. You will need yarn installed on the machine.
test.sh options
On Windows some of these targets are available as npm commands.
npm run eslint
npm run node-tests
npm run test-runners
You can attach a debugger to react-native tests by passing "Debug" to the tests.sh script. A Chrome browser will open and connect to the react native application. Use the built-in Chrome Debugger to debug the code.
./tests.sh react-tests Debug
Using Visual Studio Code
You can debug node tests using Visual Studio Code. Just use one of the launch configurations.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to info@realm.io.
See CONTRIBUTING.md for more details!
Realm JS is published under the Apache 2.0 license. The underlying core is available under the Realm Core Binary License while we work to open-source it under the Apache 2.0 license.
This product is not being made available to any person located in Cuba, Iran, North Korea, Sudan, Syria or the Crimea region, or to any other person that is not eligible to receive the product under U.S. law.
If you use Realm and are happy with it, all we ask is that you please consider sending out a tweet mentioning @realm, or email help@realm.io about your great apps!
And if you don't like it, please let us know what you would like improved, so we can fix it!
FAQs
Realm by MongoDB is an offline-first mobile database: an alternative to SQLite and key-value stores
The npm package realm receives a total of 29,010 weekly downloads. As such, realm popularity was classified as popular.
We found that realm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.