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.
⌘ + B
Be sure you have python2.7 as the default python. 3.x won't work, and it's not enough to use
--python=python2.7 as parameter to npm.
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
API documentation is written using JSDoc.
npm run jsdoc
The generated docs can be found by opening
You can use Visual Studio Code to develop and debug. In the
.vscode folder, configuration for building and debugging has been added for your convience.
To begin, you will need to build the node addon and prepare the test environment:
npm install --build-from-source --debug (cd tests && npm install)
Prior to begin debugging, you must start Realm Object Server. In VSCode, under menu Tasks/Run Task, find Download and Start Server.
In the debugging pane, you can find
Debug LLDB + NodeJS in the dropdown. First select Start Debugging in the Debug menu.
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. See https://github.com/realm/realm-js/issues/491 for more information. The best workaround is to use Safari instead, as a user has described here.
The tests will spawn a new shell when running, so you need to make sure that new shell instances use the correct version of
npm. On Mac you can add the following to your prefered shell setup:
export NVM_DIR="$HOME/.nvm" . "$(brew --prefix nvm)/nvm.sh"
You can now use
scripts/test.sh to run the various tests.
You will need yarn installed on the machine.
If you modify or add a test, please remove
tests/react-test-app/node_modules/realm-tests before running
test.sh (of course, only if you are testing with React Native).
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
test.sh script. A Chrome browser will open and connect to the react native application. Use the built-in Chrome Debugger to debug the code.
./scripts/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 a mix of the Apache License 2.0 and the Realm Platform Extensions License. Realm Core is 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!