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.
First clone this repository:
git clone https://github.com/realm/realm-js.git
Then in the cloned directory:
git submodule update --init --recursive
Note: If you have cloned the repo previously make sure you remove your node_modules directory since it may contain stale dependencies which may cause the build to fail.
To build for iOS:
RealmReact.frameworkas the build target
To build for Android:
To build for nodejs:
npm install --build-from-source=realm
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
Some users have reported the Chrome debugging being too slow to use after integrating Realm into their react-native project. This is due to the blocking nature of the RPC calls made through the Realm library. It is an ongoing issue and we are actively working on fixing it. See https://github.com/realm/realm-js/issues/491 for more information.
You can use scripts/tests.sh to run the various tests. You will need yarn installed on the machine.
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.
See CONTRIBUTING.md for more details!
Realm JS is published under the Apache 2.0 license. Realm Core is also published under the Apache 2.0 license and is available here.
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 to share your thoughts
And if you don't like it, please let us know what you would like improved, so we can fix it!