VisualNeo

VisualNeo is a visual query interface that is compatible with Neo4j. It helps non-expert users to build graphical queries without learning any Cypher language.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Running
3. Usage
4. Contact

About The Project

This project is a 2022-2023 COMP4981 Final Year Project of Hong Kong University of Science and Technology. It is implemented by Group XZ2.

The intention of the project is to respond to the increasing needs to query a graph database. Among all people using databases, many do not have computer science background and thus may face difficulties.

Fortunately, graph queries are close to human intuition and can be represented by shapes like vertices and edges. Consequently, Visual Query Interfaces (VQIs), an application on the top layer that enables users to draw graph queries intuitively, have become a feasible solution.

VisualNeo includes many cutting-edge functions such as data-driven VQI design, action-aware graph query processing, and effective query results visualization.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Please follow the instructions below to set up your VisualNeo locally:

Prerequisites

• Neo4j Desktop or Neo4j Sandbox
• JDK 17+
• Apache Maven 3.3+
• JavaFX 19

Running

1. Clone the repo

   git clone https://github.com/C1rF/VisualNeo

2. Open the project using IntelliJ or equivalent IDEs and run the project
3. Or run the following command in the root directory:

   mvn clean javafx:run

4. Or run the executable jar file using the following command in the root directory:

   mvn clean package

   java --module-path [your own javafx lib path] --add-modules javafx.controls,javafx.fxml -jar target/VisualNeo-1.0.0.jar
   

   JavaFX is separated from JDK 11+ and needed to installed independently by users. To download JavaFX, click here. Use the path of lib directory as your command line input.

(back to top)

Usage

Here is a quick guideline of how VisualNeo can be used.

1. Load the remote or local database by providing security data (uri, username, password)

2. View the metadata of the loaded database

3. Construct graph queries by pressing:

   Shift: Create nodes/edges

   Ctrl: Select multiple nodes/edges

   Backspace/Delete: Delete nodes/edges

4. Save/Load self-defined patterns (if needed)

5. Load the recommended patterns from file (if needed)

6. Fire the search and view the returned results

For more examples, please refer to the manual.

(back to top)

Contact

LIANG Houdong - @website - hliangam@connect.ust.hk

YAO Chongchong - cyaoad@connect.ust.hk

(back to top)