Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adadgio/neo4j-js-ng2
A Neo4j graph UI editor that's got solid typescript in it.
https://github.com/adadgio/neo4j-js-ng2
Last synced: 4 days ago
JSON representation
A Neo4j graph UI editor that's got solid typescript in it.
- Host: GitHub
- URL: https://github.com/adadgio/neo4j-js-ng2
- Owner: adadgio
- Created: 2017-11-14T09:36:12.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-27T17:26:25.000Z (over 1 year ago)
- Last Synced: 2024-08-02T12:52:03.435Z (3 months ago)
- Language: TypeScript
- Homepage: https://github.com/adadgio/neo4j-js-ng2
- Size: 8.52 MB
- Stars: 61
- Watchers: 4
- Forks: 16
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Support: support/neo4j-js.conf.dist
Awesome Lists containing this project
- awesome-starred - adadgio/neo4j-js-ng2 - A Neo4j graph UI editor that's got solid typescript in it. (others)
README
# Neo4jJs (v2)
A Neo4j graph database editor. Explore your **neo4j** graph, create and edit nodes and relationships
[Features and bugs roadmap](https://trello.com/b/NLtaurIH/neo4j-js-https-githubcom-adadgio-neo4j-js-ng2)
Table of Contents
=================
* [Improvements over v1](#improvements-over-v1)
* [Getting started](#getting-started)
* [Pre-requisites](#pre-requisites)
* [Quick configuration](#quick-configuration)
* [Simple queries](#simple-queries)
* [Running in production](#running-in-production)
* [Running in development](#running-in-development)
* [Known issues](#known-issues)
* [License](#license)
## Improvements over v1
**Bug improvements**
- Settings can now be updated on the fly via the UI.
- Better separated components thanks to Angular2.
- **Much much cleaner code** for developers to build upon.
- Better events handling in graph and database interaction.
- Annoying bugs and annoying features fixed from v1.
**New features**
- Editable relationships types and properties.
- Links/relationships can be created in the create mode.
- Added a plain *cypher query* mode in the main search bar (*@todo will be deprecated*)
- Settings are served from `neo4j.settings.json` and can be changed on the fly (stored in local storage).
## Getting started
- Clone or download the project
- Copy `src/assets/neo4j.settings.json.dist` to `src/assets/neo4j.settings.json`.
- Run `ng serve` or `npm start`.
### Pre-requisites
- Neo4j must be installed [Neo4j quick install instructions here](https://www.digitalocean.com/community/tutorials/how-to-install-neo4j-on-an-ubuntu-vps)
- Neo4j Basic Authentication must have been configured (by default)
- Angular2 CLI is required for running with `ng serve` or building into the `dist` folder.
### Quick configuration
- With Angular2: serve project with `ng serve`and navigate to `http://localhost:4200/`
- Without Angular2: create a virtual host on your machine and point it to the `dist` folder
- Copy `src/assets/neo4j.settings.json.dist` to `src/assets/neo4j.settings.json` and change with your settings
- Change client `authBasic` value to `Basic: `. Auth string is a **base64 encode** `username:password`
*Note:* various settings like node colors and default labels are customizable in the JSON or on the fly!
## Simple queries
Simple queries let you pop nodes on the graph very quickly without writing cypher queries. Simple queries are types in the main exploration search bar.
*Why use this instead of cypher queries?* Because it's a little bit more complicated to allow any alias such as `MATCH (myAlias) RETURN myAlias`, but that's coming in the future. Besides, for exploration, simple queries are faster user-end wise.
**Examples**
```
// simple query pseudo code format
:Label1:Label2 property="Value" limit,skip
// numbers, limit and multiple properties (AND...)
:Person name="Ben" age=12 10
// limit and skip
:Person name="Ben" age=34 50,0
// queery and show 1st level relationships (+1 flag)
:Company name="Gougle" +1
```
## Running in production
Clone the repository and point an Apache2 or Nginx virtual host to the `./dist` folder (see `./support` files for examples).
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
## Known issues
- Chrome: **Compatibility OK** (no known issues)
- In Firefox local storage is not shared between tabs so you might experience settings or debug logs inconsistent views.
## Licence
You do absolutely what you want with that project (MIT Licence).