realm - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "realm",
-  "version": "0.0.1",
-  "description": "Domain development , DDD-CRS framework for node.js .",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "description": "Realm is a mobile database: an alternative to SQLite & key-value stores",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "homepage": "https://realm.io",
+  "keywords": [
+    "database",
+    "db",
+    "react",
+    "react-native",
+    "persistence",
+    "localstorage",
+    "sqlite",
+    "asyncstorage",
+    "rocksdb",
+    "leveldb"
+  ],
+  "author": {
+    "name": "Realm",
+    "email": "[e-mail]",
+    "url": "https://realm.io"
   },
-  "dependencies": {
-    "node-uuid": ">=0.0.1",
-    "should": ">=0.0.1"
-  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/brighthas/crs.git"
+    "url": "https://github.com/realm/realm-js.git"
   },
-  "author": "brighthas",
-  "license": "BSD",
-  "readmeFilename": "README.md",
-  "gitHead": "6c890cae2bd09c5870b73fc6b766d5a6d89e1d07",
-  "directories": {
-    "example": "example",
-    "test": "test"
+  "bugs": {
+    "url": "https://github.com/realm/realm-js/issues"
   },
-  "devDependencies": {},
-  "keywords": [
-    "cqrs",
-    "ddd"
-  ]
+  "main": "lib/index.js",
+  "files": [
+    "android",
+    "lib",
+    "react-native",
+    "scripts",
+    "src",
+    "vendor",
+    "RealmJS.xcodeproj"
+  ],
+  "scripts": {
+    "get-version": "echo $npm_package_version",
+    "set-version": "scripts/set-version.sh",
+    "jsdoc": "rm -rf docs/output && jsdoc -c docs/conf.json",
+    "test": "scripts/test.sh",
+    "prepublish": "scripts/prepublish.sh"
+  },
+  "devDependencies": {
+    "jsdoc": "^3.4.0"
+  },
+  "engines": {
+    "node": ">=4"
+  }
 }

README.md

@@ -1,34 +0,88 @@
-Domain development , DDD-CRS framework for node.js .
-=======================================
+![Realm](https://github.com/realm/realm-js/raw/master/logo.png)
 
-Install 
-======
-		
-		npm install crs
+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.
 
-Example
-======
+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.
 
-		var crs = require("crs");
-		var Domain = crs.Domain;
-		var Builder = crs.Builder;
-		
-		var builder = new Builder();
-		
-		builder.bindService( ... )
-				   .bindAggreType( ... )
-				   .bindCommandHandle( ... )
-				   .bindEventHandle( ... )
-				   .bindEventHandle( ... ) 
-				   .bindDB( ... )
-		
-		var domain = new Domain(builder);
-		
-		domain.on("event01",function(){ ... });
-		domain.once("event02",function(){ ... });
-		domain.exec(" command");
+## 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](https://realm.io/docs/react-native/latest/#models) and [queryable by code](https://realm.io/docs/react-native/latest/#queries), 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](https://realm.io/docs/react-native/latest/#installation).
 
+## Documentation
 
+### Realm React Native
+
+The documentation can be found at [realm.io/docs/react-native/latest](https://realm.io/docs/react-native/latest).  
+The API reference is located at [realm.io/docs/react-native/latest/api](https://realm.io/docs/react-native/latest/api).
+
+## Getting Help
+
+- **Need help with your code?**: Look for previous questions on the  [#realm tag](https://stackoverflow.com/questions/tagged/realm?sort=newest) — or [ask a new question](https://stackoverflow.com/questions/ask?tags=realm). We actively monitor and answer questions on SO!
+- **Have a bug to report?** [Open an issue](https://github.com/realm/realm-js/issues/new). 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](https://github.com/realm/realm-js/issues/new). Tell us what the feature should do, and why you want the feature.
+- Sign up for our [**Community Newsletter**](http://eepurl.com/VEKCn) 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](https://realm.io/conduct/).
+By participating, you are expected to uphold this code. Please report unacceptable behavior to [[e-mail]](mailto:[e-mail]).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
+
+## License
+
+Realm JS is published under the Apache 2.0 license.
+The underlying core is available under the [Realm Core Binary License](https://github.com/realm/realm-cocoa/blob/master/LICENSE#L210-L243) while we [work to open-source it under the Apache 2.0 license](https://realm.io/docs/react-native/latest/#faq).
+
+**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](https://twitter.com/realm), or email [[e-mail]](mailto:[e-mail]) 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!_**
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 5 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23972289

increased by106372.52%

Dependency count

0

decreased by-100%

Number of package files

243

increased by710%

Number of medium license alerts

0

decreased by-100%

Lines of code

1229

increased by102.81%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-66.67%

Number of lines in readme file

89

increased by154.29%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Number of low license alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

7

increased byInfinity%

Dependency changes

• - Removednode-uuid@>=0.0.1

• - Removedshould@>=0.0.1

• - Removednode-uuid@1.4.8(transitive)

• - Removedshould@13.2.3(transitive)

• - Removedshould-equal@2.0.0(transitive)

• - Removedshould-format@3.0.3(transitive)

• - Removedshould-type@1.4.0(transitive)

• - Removedshould-type-adaptors@1.1.0(transitive)

• - Removedshould-util@1.0.1(transitive)