https://github.com/skaiworldwide-oss/agensgraphviewer
AgensGraph database visualisation tool
https://github.com/skaiworldwide-oss/agensgraphviewer
genai graphdb multi-model-database nosql postgresql
Last synced: about 1 year ago
JSON representation
AgensGraph database visualisation tool
- Host: GitHub
- URL: https://github.com/skaiworldwide-oss/agensgraphviewer
- Owner: skaiworldwide-oss
- Archived: true
- Created: 2025-01-15T06:00:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-03T10:31:39.000Z (about 1 year ago)
- Last Synced: 2025-04-13T12:57:36.277Z (about 1 year ago)
- Topics: genai, graphdb, multi-model-database, nosql, postgresql
- Language: JavaScript
- Homepage: http://www.skaiworldwide.com/
- Size: 1.92 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
Awesome Lists containing this project
README
# AgensGraphViewer
Web-based user interface that provides visualization of graph data stored in an AgensGraph database.
This is a sub-project of [AgensGraph](https://github.com/skaiworldwide-oss/agensgraph)
# Recommended Node Version & install module
- Node version - 14.16.0
- Node Module - pm2
Install latest **pm2** with :
```bash
npm i pm2
```
> [pm2](https://www.npmjs.com/package/pm2) is an NPM module to run the project in production mode.
# Installing AgensGraphViewer
Extract the release .zip or .tar.gz package into your desired directory.
From the commandline, navigate to the directory agv-package.
- Install the required node modules using:
```bash
npm run setup
```
# How to start using AgensGraphViewer
AgensGraphViewer is a graphical user interface for AgensGraph, so it needs an AgensGraph server running on the background.
Tipically, this is done with the command
```
ag_ctl start [-D /path/created/by/initdb]
```
For the other settings or usage instructions, please follow [AgensGraph's documentation](https://bitnine.net/documentations/quick-guide-1-3.html).
# Running AgensGraphViewer
- Run AgenGraphViewer in production environment using :
```bash
pm2 start ecosystem.config.js --env release
```
> This will start AgensGraphViewer on http://localhost:3000 if port 3000 is free.
To stop the process use the commands:
```bash
pm2 stop ag-viewer-release
pm2 delete ag-viewer-release
```
### Connect AgensGraphViewer to AgensGraph Database
**Standard Connection Settings**
- Database type: `AgensGraph`
- Connect URL : `127.0.0.1`
- Connect Port : `5432`
# Using the Docker image:
- Pulling the image:
```bash
docker pull markgomer/agensgraphviewer:1.1.0
```
- Run the container:
```bash
docker run --name agviewer -p 3000:3000 -d markgomer/agensgraphviewer:1.1.0
```
Then open the URL 127.0.0.1:3000 on your browser.
> Tip: if your AgensGraph server is running on your host machine, the URL to connect to it should be "host.docker.internal".
# For developers:
Fork this repository, then clone your fork
```bash
## install node modules
npm run setup
## start the development environment
npm run start
```