Neo4j's client application. Query, visualize, manage.
JavaScript CSS CoffeeScript HTML Smarty Java
Latest commit 01e585e Feb 15, 2017 @oskarhane oskarhane committed on GitHub Merge pull request #348 from pe4cey/remove-3.1-beta-frame
Remove from startup sequence
Permalink
Failed to load latest commit information.
app Remove from startup sequence Feb 15, 2017
copyright Update license headers to 2016 Jan 14, 2016
custom tweaked base text color to fix fullscreened guides Nov 4, 2016
lib Add helpers method to parse input params Nov 1, 2016
project subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
src/test Test against a non-milestone release of 3.0 Sep 27, 2016
sync-server Neo4j Sync Mar 29, 2016
tasks subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
test Use new api Nov 21, 2016
.bowerrc subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
.editorconfig subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
.gitattributes subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
.gitignore allow customization of Neo4j Browser content, style and settings Nov 4, 2016
.jshintrc subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
.npmrc Add npmrc file and update npm-shrinkwrap Jul 15, 2016
Gruntfile.coffee Fix `grunt server` when no custom content Nov 21, 2016
LICENSE.txt Merge remote-tracking branch '2.2' into 2.3 Aug 31, 2015
README.asciidoc Updated README for customization Nov 4, 2016
bower.json Update ascii-data-table to 2.0.0 Nov 21, 2016
buildfile Resolve varying use of neo4j vs neo4j-community Oct 31, 2014
karma-e2e.conf.js subtree merged neo4j-browser project into community/browser, then int… Nov 15, 2013
karma.conf.js Update test dependency Apr 15, 2016
npm-shrinkwrap.json Add npmrc file and update npm-shrinkwrap Jul 15, 2016
package.json Update imagemin to 1.0.0 for cleaner builds Nov 21, 2016
pom.xml Fix int test to run against 3.1.* version of neo4j Oct 13, 2016

README.asciidoc

Neo4j Browser

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.

Goals

  • developer focused

  • every interaction is a demonstration

  • uses only public APIs

  • for modern browsers, with reasonable fallbacks

Development

Set up your environment
  • Install node.js

  • Clone this Github repository

  • npm install

    This installs npm modules needed to build the browser code.

  • npm install -g grunt-cli

    This puts the grunt command on your path.

Run in development mode
  • Run Neo4j server (from a downloaded distribution of Neo4j, or from your IDE)

  • grunt server

    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.

Packaging

To package Neo4j Browser in to a jar:

  • Compile the project with grunt build

  • Build a jar using mvn package == Custom Builds ==

You can customize Neo4j Browser with your own content and styles. The build process accepts a --custom 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.

Customize
  • Fork this repository

  • Duplicate one of the included customization examples (either custom/autumn or custom/presentation) cp -r custom/presentation custom/mybrowser

  • Develop the customization grunt server --custom=mybrowser

  • See your changes at http://localhost:9000

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.

Feedback

Contributing

All bug reports, feature requests and pull requests are very welcome.

Licensing

Neo4j is an open source product. We support a Community edition under the GPLv3 license.