Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9183d49

Browse files
committedNov 3, 2024·
Adopt Gremlin Visualizer under JanusGraph
Signed-off-by: Oleksandr Porunov <alexandr.porunov@gmail.com>
1 parent 6aa6270 commit 9183d49

File tree

8 files changed

+36
-38
lines changed

8 files changed

+36
-38
lines changed
 

Diff for: ‎.github/workflows/CI.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
id: vtl
2020
uses: mapped/action-vtl@latest
2121
with:
22-
baseVersion: 2.0.0
22+
baseVersion: 1.0.0
2323
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
24-
dockerImage: docker.io/mapped/gremlin-visualizer
24+
dockerImage: docker.io/janusgraph/janusgraph-visualizer
2525

2626
- name: Setup nodejs
2727
uses: actions/setup-node@v4
@@ -47,7 +47,7 @@ jobs:
4747
uses: docker/login-action@v3
4848
with:
4949
username: ${{ secrets.DOCKERHUB_USERNAME }}
50-
password: ${{ secrets.DOCKERHUB_WRITE_TOKEN }}
50+
password: ${{ secrets.DOCKERHUB_TOKEN }}
5151

5252
- name: Build docker and push
5353
id: docker_build

Diff for: ‎README.md

+25-27
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
1-
# Gremlin-Visualizer
1+
# JanusGraph-Visualizer
22
This project is to visualize the graph network corresponding to a gremlin query.
3-
Original gremlin-visualizer can be found [here](https://github.com/prabushitha/gremlin-visualizer).
43

5-
![alt text](https://raw.githubusercontent.com/prabushitha/Readme-Materials/master/Gremlin-Visualizer.png)
4+
![alt text](https://github.com/JanusGraph/janusgraph-visualizer/blob/master/assets/JanusGraph-Visualizer.png)
65

7-
### What is the different in this fork comparing to the origin repo
8-
9-
1. Added suppport for different graph names
10-
2. Added GitHub actions to build & push Docker image
11-
3. Added productions mode to host in Kubernetes
12-
4. Added ability to override default values (graph host, port, name) via environement variables
13-
14-
### Setting Up Gremlin Visualizer
15-
To setup gremlin visualizer, you need to have `node.js` and `npm` installed in your system.
6+
### Setting Up JanusGraph Visualizer
7+
To setup JanusGraph visualizer, you need to have `node.js` and `npm` installed in your system.
168

179
* Clone the project
1810
```sh
19-
git clone https://github.com/mapped/gremlin-visualizer-graph.git
11+
git clone https://github.com/JanusGraph/janusgraph-visualizer.git
2012
```
2113
* Install dependencies
2214
```sh
@@ -35,37 +27,37 @@ Note - Frontend starts on port 3000 and simple Node.js server also starts on por
3527

3628
#### Setting up with Docker
3729

38-
You can build a Docker image of the gremlin visualizer with the included `Dockerfile`.
39-
This will use the current version of the `master` branch of the source GitHub repository.
30+
You can build a Docker image of the JanusGraph visualizer with the included `Dockerfile`.
31+
This will use the current version of the `main` branch of the source GitHub repository.
4032
The Docker image can be built by calling the `docker build` command, for example:
4133

4234
```sh
43-
docker build --tag=gremlin-visualizer:latest .
35+
docker build --tag=janusgraph-visualizer:latest .
4436
```
4537

46-
The image can also be downloaded from Docker hub: [`mapped/gremlin-visualizer:latest`](https://hub.docker.com/r/mapped/gremlin-visualizer).
38+
The image can also be downloaded from Docker hub: [`janusgraph/janusgraph-visualizer:latest`](https://hub.docker.com/r/janusgraph/janusgraph-visualizer).
4739

4840
```sh
49-
docker pull mapped/gremlin-visualizer:latest
41+
docker pull janusgraph/janusgraph-visualizer:latest
5042
```
5143

5244
The Docker image can then be run by calling `docker run` and exposing the necessary ports for communication. See [Docker's documentation](https://docs.docker.com/engine/reference/commandline/run/) for more options on how to run the image.
5345

5446
```sh
5547
# if you built the image yourself
56-
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=gremlin-visualizer --network=host gremlin-visualizer:latest
48+
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=janusgraph-visualizer --network=host janusgraph-visualizer:latest
5749
# if you downloaded from Docker Hub
58-
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=gremlin-visualizer --network=host mapped/gremlin-visualizer:latest
50+
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=janusgraph-visualizer --network=host janusgraph/janusgraph-visualizer:latest
5951
```
6052
Note that `--network=host` is not needed if you don't run your gremlin server in the host machine.
6153

62-
The Docker container can be stopped by calling `docker stop gremlin-visualizer`.
54+
The Docker container can be stopped by calling `docker stop janusgraph-visualizer`.
6355

6456
### Usage
65-
* Start Gremlin-Visualizer as mentioned above
57+
* Start JanusGraph-Visualizer as mentioned above
6658
* Start or tunnel a gremlin server
6759
* Specify the host and port of the gremlin server
68-
* Write an gremlin query to retrieve a set of nodes (eg. `g.V()`)
60+
* Write a gremlin query to retrieve a set of nodes (eg. `g.V()`)
6961

7062
### Features
7163
* If you don't clear the graph and execute another gremlin query, results of previous query and new query will be merged and be shown.
@@ -74,10 +66,16 @@ The Docker container can be stopped by calling `docker stop gremlin-visualizer`.
7466
* View the set of queries executed to generate the graph
7567
* Traverse in/out from the selected node
7668

77-
###
78-
## Contributors
79-
* Umesh Jayasinghe (Github: prabushitha)
69+
## Credits
70+
JanusGraph-Visualizer is based on the original Gremlin-Visualizer that can be found [here](https://github.com/prabushitha/gremlin-visualizer).
71+
Author of the original Gremlin-Visualizer is: [Umesh Jayasinghe](https://github.com/prabushitha).
72+
73+
### What is the different in this fork comparing to the origin repo
74+
1. Added suppport for different graph names
75+
2. Added GitHub actions to build & push Docker image
76+
3. Added productions mode to host in Kubernetes
77+
4. Added ability to override default values (graph host, port, name) via environement variables
8078

8179
## Something Missing?
8280

83-
If you have new ideas to improve please create a issue and make a pull request
81+
If you have new ideas to improve please create an issue and make a pull request

Diff for: ‎assets/JanusGraph-Visualizer.png

148 KB
Loading

Diff for: ‎package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "gremlin-visualizer",
2+
"name": "janusgraph-visualizer",
33
"version": "1.0.0",
4-
"author": "Umesh Jayasinghe",
4+
"author": "JanusGraph Contributors",
55
"description": "Visualize graph network corresponding to a gremlin query",
66
"license": "MIT",
77
"dependencies": {

Diff for: ‎public/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
66
<meta name="theme-color" content="#000000">
77
<link rel="manifest" href="%PUBLIC_URL%/manifest.json">
8-
<link rel="shortcut icon" href="%PUBLIC_URL%/gremlin-visualizer.png">
8+
<link rel="shortcut icon" href="%PUBLIC_URL%/janusgraph-visualizer.png">
99
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
1010
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
1111
<style type="text/css">
@@ -23,7 +23,7 @@
2323
width: 100%;
2424
}
2525
</style>
26-
<title>Gremlin-Visualizer</title>
26+
<title>JanusGraph-Visualizer</title>
2727
</head>
2828
<body>
2929
<noscript>
File renamed without changes.

Diff for: ‎public/manifest.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"short_name": "Gremlin-Visualizer",
2+
"short_name": "JanusGraph-Visualizer",
33
"name": "Gremlin Visualizer",
44
"icons": [
55
{
6-
"src": "gremlin-visualizer.png",
6+
"src": "janusgraph-visualizer.png",
77
"sizes": "64x64",
88
"type": "image/png"
99
}

0 commit comments

Comments
 (0)
Please sign in to comment.