Neo4jMapper is an object modeler for Neo4j Graphdatabases written in JavaScript
JavaScript CoffeeScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmark
examples
src
test
.gitignore
.travis.yml
LICENSE
Makefile
README.md
package.json

README.md

Neo4jMapper

Object Modeler for Neo4j Graphdatabases

Written in JavaScript for browser- and serverside usage

Build Status NPM version

Documentation and Examples

See http://pstaender.github.io/neo4jmapper for Documentation and Examples

Installation

  $ npm install neo4jmapper

Tests

  $ npm install
  $ npm test

Beware that a lot of nodes will be written and kept in your database, so avoid running any of these tests + examples on productive instances.

Using Neo4jMapper in a browser

Since the maintenance for browser- and server-side is too much, the browser support is stopped for now. However Neo4jMapper should still be working in the browser.

Scripts

  • $ npm run doc: Creates a source code documentation (with docco) in docs/
  • $ make test-coverage: Creates a code coverage report in coverage/
  • $ npm run apidocs: Creates a rudimentary api doc apidocs/

TODO

  • implement: index relationship
  • implement: stream feature for browser-side-usage
  • move from restful api to cypher queries if possible (to reduce api dependencies)
  • complete documentation
  • cleanup redundant tests
  • dox (markdown and jsdoc flavoured) sourcecode documentation
  • use parameter-values by default for all statement segments that are generated

Tested against:

LICENSE

© 2015 by Philipp Staender under the GNU General Public License See in LICENSE file for further details.