status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Realm is a mobile database: an alternative to SQLite & key-value stores https://realm.io
1,060 Commits 61 Branches 80 Tags 8.2 MiB
JavaScript 45.9%
C++ 38.4%
Objective-C 3.9%
Shell 3.3%
Objective-C++ 3.2%
Other 5.3%
Go to file
Scott Kyle ba0ff5fbaf Merge pull request #265 from realm/nh/fixes_255_debug_server 
start debug server only on when using chrome debug
 		2016-02-19 16:25:14 -08:00
RealmJS.xcodeproj Add Mixpanel analytics for iOS 2016-02-18 13:58:12 -08:00
docs Remove some API doc qualifiers 2016-02-12 16:57:13 -08:00
examples No longer delete before npm installing local modules 2016-02-19 02:03:54 -08:00
lib Merge pull request #257 from realm/sk-schema-prop 2016-02-18 16:27:47 -08:00
react-native PR feedback 2016-02-19 22:50:30 +00:00
scripts Remove installArchives for Android from test script 2016-02-19 02:53:47 -08:00
src PR feedback 2016-02-19 22:50:30 +00:00
tests No longer delete before npm installing local modules 2016-02-19 02:03:54 -08:00
vendor Fixing submodule deps 2016-01-28 16:18:09 +00:00
.eslintrc Add ESLint config for JS test files 2015-10-21 15:20:44 -07:00
.gitignore adding a 'publishAndroid' task to generate the AAR with prebuilt .so files 2016-02-10 16:11:36 -08:00
.gitmodules API documentation 2016-02-12 16:57:13 -08:00
CONTRIBUTING.md Fix some typos and wording issues in README 2016-02-17 18:19:35 -08:00
LICENSE add license 2015-10-27 14:15:28 -07:00
README.md Temporarily remove License from README 2016-02-18 15:28:41 -08:00
logo.png add logo 2016-02-18 13:50:56 -08:00
package.json Add script to update version in package.json and iOS 2016-02-18 13:58:12 -08:00

README.md

Realm

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 React Native.

Currently we only support React Native (both iOS & Android) but we are considering adding support for Cordova/PhoneGap/Ionic as well as Node.js (V8) soon.

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 React Native.

Documentation

Realm React Native

The documentation can be found at realm.io/docs/react-native/latest.
The API reference is located at realm.io/docs/react-native/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+
  • 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

To build for iOS:

  • Open RealmJS.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

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!

Feedback

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!