Skip to content

Commit 9131eda

Browse files
committed
Adding description of visualization in README and added a screenshot related to the visualizer
1 parent 201ba54 commit 9131eda

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,24 @@ Each row in `data/build_info.csv` consists of the following:
176176
- `gradle_version`: if built successfully with Gradle, the Gradle version used. Otherwise, it will be `n/a`
177177
- `use_gradlew`: if built successfully with the custom `gradlew` script provided with the project itself, it will be `1`. Otherwise it will be `n/a`
178178

179+
## Visualization
180+
181+
We provide a simple website that helps visualize the CVEs and provide necessary pointers to details of the CVEs provided in the dataset.
182+
You can start a simple Python http server by running the following script in your terminal:
183+
184+
``` bash
185+
$ python3 -m http.server
186+
```
187+
188+
Then you can visit the webpage in your browser by navigating to `http://localhost:8000/visualization/index.html`.
189+
If all the projects are fetched properly, you should see the following interface in your browser:
190+
191+
![visualization](resources/visualizer-screenshot.png)
192+
193+
As shown in the screenshot, you will be able to navigate to the corresponding Github repository, an NVD advisory page, and look at the files and diffs related to the fix of the vulnerability.
194+
All the links are clickable and take you straight to the source in Github.
195+
The visualization page also provides functionalities to search and filter projects by CWEs, which should come in handy when you need to closely investigate the vulnerabilities.
196+
179197
## Citation
180198

181199
Consider citing our paper:
1010 KB
Loading

0 commit comments

Comments
 (0)