Skip to content

Commit 73b9af6

Browse files
Updated README.md
1 parent 5ead4f4 commit 73b9af6

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
11
# sw-metadata-bot-monitor-web
2+
23
A website to display the results of running the sw metadata bot on different organizations
4+
5+
## Generating the Dashboard
6+
7+
The landing page (`index.html`) is generated dynamically from the JSON data report using a Python script and a Mustache template.
8+
9+
### Requirements
10+
11+
You need Python 3 and the `pystache` library to generate the HTML file:
12+
13+
```bash
14+
pip install pystache
15+
```
16+
17+
### How to Generate
18+
19+
1. Ensure that the latest JSON report is saved as `created_issues_report.json` in this directory.
20+
2. Run the generation script:
21+
22+
```bash
23+
python generate.py
24+
```
25+
26+
This script will read the JSON data, parse it, and render it through `template.mustache` to output a the `index.html` file in the same directory.

generate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def main():
5555
with open("index.html", "w") as f:
5656
f.write(html)
5757

58-
print("Successfully generated index.html")
58+
print("#### index.html was generated successfully ####")
5959

6060
if __name__ == "__main__":
6161
main()

0 commit comments

Comments
 (0)