Skip to content

Latest commit

 

History

History
113 lines (78 loc) · 4.03 KB

README.md

File metadata and controls

113 lines (78 loc) · 4.03 KB
Raw


Logo

Neptune Connect

Neptune Connect is a free interactive tool for querying, optimizing, analyzing, and visualizing your Gremlin-based graph database data.
View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Screenshot

Neptune Connect is a free interactive tool for querying, optimizing, analyzing, and visualizing your Gremlin-based graph database data.

Features

  • Effortlessly query your data: Find the data you need within seconds using Neptune Connect's built-in query editor. With both Table view and JSON view options, you can easily work with the data.

  • Powerful Query Builder: The powerful query builder eliminates the need to write custom queries. With Neptune Connect, you can easily generate queries for performing basic to advanced operations, including data editing, inserting, and deleting.

  • Generate reports from your data: Utilize Neptune Connect to generate reports in various formats, presenting the data exactly the way you want it.

  • Highly-Configurable RBAC: With a highly-configurable Role-Based Access Control (RBAC) system, you have granular control over user permissions. Additionally, query logs record every executed query within the system.

  • Data Visualization: Neptune Connect provides powerful visualization capabilities for nodes and edges, enabling you to easily understand the relationships between different entities.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgments section. Here are a few examples.

  • TypeScript
  • NodeJS
  • Fastify
  • EJS
  • Prisma
  • StencilJS

Getting Started

To use Neptune Connect, you can install it on a server or your local machine. If you choose to set it up on a local server, make sure you have a running Gremlin database.

Prerequisites

  1. NodeJS 16.x.
  2. NPM
  3. Curl and Wget
  4. AWS Neptune or local gremlin instance
  5. Active internet connection

Installation

Using the installer

To install Neptune Connect on your system, run the following command

bash <(curl -s https://neptune-cdn.s3.amazonaws.com/install.sh)

The above script will automatically execute a .sh file and download the necessary files. During the installation process, you will be prompted to provide some configuration settings for Neptune Connect.

Manually installing

To install Neptune Connect manually, follow the following steps.

  • Clone the repository.
  • Install packages using npm run install
  • Create .env based on .env.example file
  • Run npm run prisma:migrate to generate SQLite database with all needed tables
  • Finally run npm run start to start the server

Usage

Watch the video

Roadmap

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the Server Side Public License. See LICENSE.md for more information.