|
| 1 | +<a name="readme-top"></a> |
| 2 | + |
| 3 | +<br /> |
| 4 | +<div align="center"> |
| 5 | + <a href="https://github.com/SwapnilTechVariable/NeptuneConnect"> |
| 6 | + <img src="https://neptune-cdn.s3.amazonaws.com/logo.png" alt="Logo" width="80" height="80"> |
| 7 | + </a> |
| 8 | + |
| 9 | + <h3 align="center">Neptune Connect</h3> |
| 10 | + |
| 11 | + <p align="center"> |
| 12 | + Neptune Connect is a free interactive tool for querying, optimizing, analyzing, and visualizing your Gremlin-based graph database data. |
| 13 | + <br /> |
| 14 | + <a href="https://github.com/demo-website">View Demo</a> |
| 15 | + · |
| 16 | + <a href="https://github.com/issues">Report Bug</a> |
| 17 | + · |
| 18 | + <a href="https://github.com/issues">Request Feature</a> |
| 19 | + </p> |
| 20 | +</div> |
| 21 | + |
| 22 | + |
| 23 | +<!-- TABLE OF CONTENTS --> |
| 24 | +<details> |
| 25 | + <summary>Table of Contents</summary> |
| 26 | + <ol> |
| 27 | + <li> |
| 28 | + <a href="#about-the-project">About The Project</a> |
| 29 | + <ul> |
| 30 | + <li><a href="#features">Features</a></li> |
| 31 | + <li><a href="#built-with">Built With</a></li> |
| 32 | + </ul> |
| 33 | + </li> |
| 34 | + <li> |
| 35 | + <a href="#getting-started">Getting Started</a> |
| 36 | + <ul> |
| 37 | + <li><a href="#prerequisites">Prerequisites</a></li> |
| 38 | + <li><a href="#installation">Installation</a></li> |
| 39 | + </ul> |
| 40 | + </li> |
| 41 | + <li><a href="#usage">Usage</a></li> |
| 42 | + <li><a href="#roadmap">Roadmap</a></li> |
| 43 | + <li><a href="#license">License</a></li> |
| 44 | + <li><a href="#contact">Contact</a></li> |
| 45 | + </ol> |
| 46 | +</details> |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +<!-- ABOUT THE PROJECT --> |
| 51 | +## About The Project |
| 52 | + |
| 53 | +[![Product Name Screen Shot][product-screenshot]](https://example.com) |
| 54 | + |
| 55 | +Neptune Connect is a free interactive tool for querying, optimizing, analyzing, and visualizing your Gremlin-based graph database data. |
| 56 | + |
| 57 | +### Features |
| 58 | + |
| 59 | +#### Effortlessly query your data |
| 60 | +Find the data you need in seconds with Neptune Connect’s built-in query editor. With both Table view and JSON view, you can easily play with the data. |
| 61 | + |
| 62 | +#### Powerful Query Builder |
| 63 | +With a powerful query builder, there is no need to write your custom query. With Neptune-Connect you can easily generate queries for performing basic to advanced operations. |
| 64 | + |
| 65 | +#### Generate reports from your data |
| 66 | +Use Neptune-Connect to generate reports in various formats with the data you want in the way you want. |
| 67 | + |
| 68 | +#### Highly-Configurable RBAC |
| 69 | +With a highly-configurable RBAC system, you can control who can do what. Furthermore, with query logs, every query executed in the system is logged. |
| 70 | + |
| 71 | +#### Edit and Insert data with query |
| 72 | +With a powerful way to insert or edit data using the UI, there is no need to update or insert data by manually writing complex queries. |
| 73 | + |
| 74 | +#### Visualize the data |
| 75 | +With a powerful way to visualize the nodes and edges, Neptune Connect helps you to easily understand the relationship between the nodes. |
| 76 | + |
| 77 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 78 | + |
| 79 | + |
| 80 | +### Built With |
| 81 | + |
| 82 | +This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. |
| 83 | + |
| 84 | +- TypeScript |
| 85 | +- NodeJS |
| 86 | +- Fastify |
| 87 | +- EJS |
| 88 | +- Prisma |
| 89 | + |
| 90 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | +<!-- GETTING STARTED --> |
| 95 | +## Getting Started |
| 96 | + |
| 97 | +Neptune Connect can be installed on both a server or your local machine. If you're setting it up on a local server then you need to have a running gremlin database. |
| 98 | + |
| 99 | +### Prerequisites |
| 100 | + |
| 101 | +1. NodeJS 16.x. |
| 102 | +2. NPM |
| 103 | +3. Curl and Wget |
| 104 | +4. AWS Neptine or local gremlin instance |
| 105 | +5. Active internet connection |
| 106 | + |
| 107 | +### Installation |
| 108 | + |
| 109 | +To install Neptune Connect on your system, run the following command |
| 110 | + |
| 111 | +```bash |
| 112 | +bash <(curl -s https://neptune-cdn.s3.amazonaws.com/install.sh) |
| 113 | +``` |
| 114 | + |
| 115 | +This script mentioned above will automatically run a `.sh` file and download the nexessery files. |
| 116 | + |
| 117 | +Note: The script will ask some questions to set up Neptune Connect. |
| 118 | + |
| 119 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 120 | + |
| 121 | +<!-- USAGE EXAMPLES --> |
| 122 | +## Usage |
| 123 | + |
| 124 | + |
| 125 | + |
| 126 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 127 | + |
| 128 | + |
| 129 | + |
| 130 | +<!-- ROADMAP --> |
| 131 | +## Roadmap |
| 132 | + |
| 133 | +- [ ] Add support for database visualizations |
| 134 | +- [ ] Add support to save queries |
| 135 | +- [ ] Add support for dark mode |
| 136 | + |
| 137 | +See the [open issues](https://github.com/SwapnilTechVariable/NeptuneConnect/issues) for a full list of proposed features (and known issues). |
| 138 | + |
| 139 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 140 | + |
| 141 | +<!-- LICENSE --> |
| 142 | +## License |
| 143 | + |
| 144 | +Distributed under the Server Side Public License. See `LICENSE.md` for more information. |
| 145 | + |
| 146 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
0 commit comments