Realm is a mobile database: an alternative to SQLite & key-value stores https://realm.io

Go to file

Ari Lazier 67922f8299 Update README.md		2015-10-27 14:41:07 -07:00
ReactNative	change the license before starting the beta	2015-10-27 14:15:21 -07:00
RealmJS.xcodeproj	apply newest object store changes	2015-10-26 15:27:43 -07:00
examples	Remove RCTTest linkage from ReactTests and ReactExample	2015-10-26 14:57:06 -07:00
lib	don't convert undefined to null in rpc requests	2015-10-27 12:13:57 -07:00
src	change the license before starting the beta	2015-10-27 14:15:21 -07:00
tests	change the license before starting the beta	2015-10-27 14:15:21 -07:00
vendor	partial port of rpc server to cpp	2015-10-22 10:44:10 -07:00
.eslintrc	Add ESLint config for JS test files	2015-10-21 15:20:44 -07:00
.gitignore	Add some Node things to gitignore	2015-10-07 17:08:30 -07:00
.gitmodules	Add GCDWebServer as a submodule at version 3.2.7	2015-10-07 17:36:22 -07:00
LICENSE	add license	2015-10-27 14:15:28 -07:00
README.md	Update README.md	2015-10-27 14:41:07 -07:00

README.md

RealmJS

Realm is a mobile database that runs directly inside phones, tablets or wearables. This repository holds the source code for Realm's JavaScript bindings for integrating with mobile apps built using ReactNative and PhoneGap.

Setup

This repository uses submodules so you need to run git submodule update --init --recursive in the realm-js root directory before running any examples or including the project in your app.

ReactNative Example

Make sure your environment is set up to run react native applications. Follow the instructions here https://facebook.github.io/react-native/docs/getting-started.html.

The ReactNative exampoe project is in the examples/ReactExample directory. You need to run npm install in this directory before running the example for the first time.

ReactNative Project Setup

Create a new ReactNative project react-native init <project-name> and open the generated XCode project.
Drag RealmJS.xcodeproj into the Libraries folder in your project.
In the target for your application, add libRealmReact.a in the Link Binary with Library build phase.
Use Realm in your app.
Drag RealmJS.framework from the Products directory under RealmJS.xcodeproj into the Embedded Libraries section in the General tab for you app's target settings. This bundles the library with your app.

Documentation

Currently there is no documentation for the current apis. You can see examples of how to use the apis in the example app and in the js test files here: https://github.com/realm/realm-js/tree/master/tests