Skip to content

Commit b5c609b

Browse files
committed
improved project description
1 parent e6c324a commit b5c609b

File tree

4 files changed

+22
-15
lines changed

4 files changed

+22
-15
lines changed

FileMap.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
text-shadow: 0 0 10px #000;
4949
}
5050
</style>
51-
<title>🔍 Visualizer</title>
51+
<title>🔍 Source Code Visualizer</title>
5252
</head>
5353

5454
<body id="body">

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11

2-
# Visualize Source Code
2+
# Source Code Visualizer
33

4-
Visualize how code is distributed among a project's files and folders
4+
Visualize the code distribution in a project.
55

6-
## Todo
6+
![Visualizing the source code distribution in Apache httpd](visualizecodevideo.gif)
77

8-
- [ ] change to better treemap lib that displays folders too
9-
- [ ] change tooltip to not overflow on right or bottom
10-
- [ ] correctly resize chart when window size changes
8+
## Applications
119

12-
## Done
10+
Applications include:
1311

14-
- [X] add option to set custom source code file extensions
15-
- [x] give appropiate message if no source files found
16-
- [x] enter target path in webui
17-
- [x] Start http server and automatically update
18-
- [x] Add title, explentation, link to top of webpage
19-
- [x] try designing header w/info that won't ruin tree map
20-
- [x] automatically open browswer when ready
12+
* Visualizing code distribution for more educated development and managment plans
13+
* Helping identify needlessly complex code modules
14+
* Mapping the attack surface from a vulnerability analysis perspective
15+
16+
## Current Features
17+
18+
- [X] Visualize how a projects source code is distributed among files and folders
19+
- [X] Zoom, hover and drag to explore the source code map
20+
- [X] Set a custom file extension filter to only view relevant source code files
21+
22+
## Road Map
23+
24+
- [ ] Improve the treemap display to better show folders
25+
- [ ] Implement CSRF Tokens to mitigate possible information disclosure
26+
- [ ] Implement autocomplete in the directory input field (according to available files on computer)
27+
- [ ] Allow custom file extension filters

visualizecodevideo.gif

392 KB
Loading

visualizecodevideo.mp4

340 KB
Binary file not shown.

0 commit comments

Comments
 (0)