Skip to content

Commit 6aa6270

Browse files
authored
Merge pull request #1 from mapped/readme
Adjust readme
2 parents fc0affd + e5d0a91 commit 6aa6270

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

Diff for: README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
### What is the different in this fork comparing to origin repo
1+
# Gremlin-Visualizer
2+
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).
4+
5+
![alt text](https://raw.githubusercontent.com/prabushitha/Readme-Materials/master/Gremlin-Visualizer.png)
6+
7+
### What is the different in this fork comparing to the origin repo
28

39
1. Added suppport for different graph names
410
2. Added GitHub actions to build & push Docker image
511
3. Added productions mode to host in Kubernetes
612
4. Added ability to override default values (graph host, port, name) via environement variables
713

8-
# Gremlin-Visualizer
9-
This project is to visualize the graph network corresponding to a gremlin query.
10-
11-
![alt text](https://raw.githubusercontent.com/prabushitha/Readme-Materials/master/Gremlin-Visualizer.png)
12-
1314
### Setting Up Gremlin Visualizer
1415
To setup gremlin visualizer, you need to have `node.js` and `npm` installed in your system.
1516

1617
* Clone the project
1718
```sh
18-
git clone https://github.com/prabushitha/gremlin-visualizer.git
19+
git clone https://github.com/mapped/gremlin-visualizer-graph.git
1920
```
2021
* Install dependencies
2122
```sh
@@ -42,10 +43,10 @@ The Docker image can be built by calling the `docker build` command, for example
4243
docker build --tag=gremlin-visualizer:latest .
4344
```
4445

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

4748
```sh
48-
docker pull prabushitha/gremlin-visualizer:latest
49+
docker pull mapped/gremlin-visualizer:latest
4950
```
5051

5152
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.
@@ -54,7 +55,7 @@ The Docker image can then be run by calling `docker run` and exposing the necess
5455
# if you built the image yourself
5556
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=gremlin-visualizer --network=host gremlin-visualizer:latest
5657
# if you downloaded from Docker Hub
57-
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=gremlin-visualizer --network=host prabushitha/gremlin-visualizer:latest
58+
docker run --rm -d -p 3000:3000 -p 3001:3001 --name=gremlin-visualizer --network=host mapped/gremlin-visualizer:latest
5859
```
5960
Note that `--network=host` is not needed if you don't run your gremlin server in the host machine.
6061

0 commit comments

Comments
 (0)