realm-js/README.md at ea0d92c20597bb75bdb2fec8377b4be00a40b134

mirror of https://github.com/status-im/realm-js.git synced 2025-01-09 22:05:57 +00:00

Thomas Goyne 3a8ee98f72 Merge remote-tracking branch 'origin/master' into next-major

* origin/master: (87 commits)
  Disable testAddListener when running in chrome
  Ensure RN has an event loop running for async tests
  Make permission tests better handle server delays
  Fix race conditions in testAddListener
  Separate build and test steps in xcode to reduce chance of hitting "Early unexpected exit"
  Ignore errors when sourcing nvm.sh
  Don't forward arguments to nvh.sh
  Skip sourcing nvm.sh if it's already available
  Fix some shellcheck warnings
  Ensure node 6.5.0 is installed on CI
  Build realm from source for each test-runner test
  Improve error reporting for incorrect argument counts for Realm methods
  Use the same error messages in the RPC code as the regular code
  Silence an unused variable warning when building with sync disabled
  Documenting sync.config properties (#1312)
  Check the exception message in all Realm tests which assert an exception is thrown
  Don't discard the actual error message in validated_get_X
  Add the invalid value to the type error exception message
  Improve the errors thrown for invalid schema definitions
  Throw a more appropriate error for some operations on closed Realms
  ...

2017-09-19 16:36:49 -07:00

5.7 KiB

Raw Blame History

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.

Features

Mobile-first: Realm is the first database built from the ground up to run directly inside phones, tablets and wearables.
Simple: Data is directly exposed as objects and queryable by code, removing the need for ORM's riddled with performance & maintenance issues.
Modern: Realm supports relationships, generics, and vectorization.
Fast: Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.

Getting Started

Please see the detailed instructions in our docs to use Realm Javascript.

Documentation

Realm React Native and Node.js

The documentation can be found at realm.io/docs/javascript/latest.
The API reference is located at realm.io/docs/javscript/latest/api.

Getting Help

Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We actively monitor and answer questions on SO!
Have a bug to report? Open an issue. If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blog posts and tutorials about Realm.

Building Realm

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:

Node: 4.0 <= version < 7.0
Xcode 7.2+
Android SDK 23+
Android NDK 10e

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:

Open react-native/ios/RealmReact.xcodeproj
Select RealmReact.framework as the build target
Build

To build for Android:

cd react-native/android
./gradlew publishAndroid
The compiled version of the Android module is here: <project-root>/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
  - Check node-gyp manual for custom installation procedure for Windows

Running the tests

You can use scripts/tests.sh to run the various tests. You will need yarn installed on the machine.

test.sh options

eslint - lints the sources
react-tests - runs all React Native tests on iOS Simulator
react-tests-android runs all React Native Android tests on Android emulator
node - runs all tests for node
test-runners - checks supported tests runners are working correctly

On Windows some of these targets are available as npm commands.

npm run eslint
npm run node-tests
npm run test-runners

Debugging the tests

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.

Code of Conduct

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.

Contributing

See CONTRIBUTING.md for more details!

License

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.

Feedback

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!

5.7 KiB Raw Blame History Unescape Escape