Explore the graph, one query at a time.
Neo4j Browser is Neo4j’s built-in client application, a mashup of a REPL, data visualization and lightweight IDE.
every interaction is a demonstration
uses only public APIs
for modern browsers, with reasonable fallbacks
- Set up your environment
Clone this Github repository
This installs npm modules needed to build the browser code.
npm install -g grunt-cli
This puts the
gruntcommand on your path.
- Run in development mode
Run Neo4j server (from a downloaded distribution of Neo4j, or from your IDE)
This listens on port 9000, serving up static documents, and forwarding other HTTP requests to Neo4j on port 7474. Bolt requests are not forwarded, they are sent directly to the Neo4j server on port 7687. Any local changes to the browser code will be applied immediatley by reloading the page.
- Sync server
To setup a local sync login server go to project root and invoke
node sync-server/server.js. An express server now started on https://localhost:9001 with self signed TLS certificates.
To package Neo4j Browser in to a jar:
Compile the project with
Build a jar using
mvn package== Custom Builds ==
You can customize Neo4j Browser with your own content and styles. The build process accepts a
switch that specifies a subdirectory of the
./custom to be layered onto the standard build. By layering,
your fork of neo4j-browser can continue to get updates without interfering with your work.
Fork this repository
Duplicate one of the included customization examples (either
cp -r custom/presentation custom/mybrowser
Develop the customization
grunt server --custom=mybrowser
See your changes at
Adding a new Cypher keyword
The resulting artifact can be loaded by replacing the existing Neo4j Browser jar in the Neo4j
lib directory and restarting the server to remount the new assets.
Questions or comments? - Join the Neo4j users Slack community
All bug reports, feature requests and pull requests are very welcome.
Neo4j is an open source product. We support a Community edition under the GPLv3 license.