Neo4j is the world’s leading Graph Database. It is a high performance graph store with all the features expected of a mature and robust database, like a friendly query language and ACID transactions. The programmer works with a flexible network structure of nodes and relationships rather than static tables — yet enjoys all the benefits of enterprise-quality database. For many applications, Neo4j offers orders of magnitude performance benefits compared to relational DBs.
Learn more on the Neo4j website.
Neo4j is available both as a standalone server, or an embeddable component. You can download or try online.
We encourage experimentation with Neo4j. You can build extensions to Neo4j, develop library or drivers atop the product, or make contributions directly to the product core. You’ll need to sign a Contributor License Agreement in order for us to accept your patches.
For a quick overview of the components in this repository, you can read the RepositoryOverview.asciidoc.
|
Note
|
This GitHub repository contains mixed GPL and AGPL code. Our Community edition (in the community/ directory) is GPLv3. Our Enterprise edition (enterprise/) is differently licensed under the AGPLv3. |
Neo4j is built using Apache Maven version 3.0.x and a recent version of Java 7. Bash and Make is also required. Note that maven needs more memory than the standard configuration, this can be achieved with export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m".
The Neo4j Browser module is built using Node.js. For skipping that part of the build, see below. Building the manual requires Python, graphviz and make.
OSX users need to have Homebrew installed.
brew install graphviz libtool maven node.js
Node.js and npm are required to build the neo4j browser. In addition, on some machines it was necessary to install grunt-cli:
npm install grunt-cli
If you don’t plan to build the browser (for example by using -DskipBrowser), then don’t worry about this step.
-
A plain
mvn clean installwill only build the individual jar files. -
Test execution is, of course, part of the build.
-
To add execution of integration tests, use:
mvn clean install -DrunITs. -
In case you just want the jars, without compiling the tests, this is for you:
mvn clean install -DminimalBuild. -
To skip building the browser module, use
-DskipBrowser(note that you might not be able to build the server without it). -
To build everything, including running all tests, producing documentation and assembling product packages, use
mvn clean install -DfullBuild. -
To build the documentation see the Neo4j manual.
-
When building on Windows, use
-Dlicensing.skipto avoid problems related to line endings. -
The license header check can be skipped by appending the following to the command line:
-Dlicense.skip=true. -
If you are running into problems building on Windows you can try building Neo4j in a Ubuntu virtual machine.
-
You may need to increase the memory available to Maven:
export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=256m".
After running a mvn clean install -DfullBuild cd into packaging/standalone/target and extract the version you want, then
bin/neo4j start
in the extracted folder to start Neo4j on localhost:7474. On Windows you want to run
bin\Neo4j.bat
instead.
Or, if you are not interested in the tarballs and just want to run Neo4j you can instead run a mvn clean install -DminimalBuild and then cd into community/server and run
mvn clean compile exec:java
to start Neo4j.
Neo4j is an open source product. We support a Community edition under the GPLv3 license. The Enterprise edition is available under the AGPLv3 license for open source projects otherwise under a commercial license from Neo Technology.