G.Hemanth Sai commited on
Commit
fc6a523
·
1 Parent(s): 662a13d

Included demo screenshots

Browse files
Files changed (1) hide show
  1. README.md +12 -0
README.md CHANGED
@@ -20,6 +20,7 @@ $ pip install -r requirements.txt
20
  $ -- Run backend
21
  $ uvicorn app:app --reload # For running the FastAPI server
22
  $ -- Run frontend
 
23
  $ streamlit run app.py # For running the Streamlit App
24
  ```
25
 
@@ -30,6 +31,17 @@ $ streamlit run app.py # For running the Streamlit App
30
  - Now, you can paste your code in the `Code` field and click on the `Generate Documentation` button.
31
  - The generated documentation will be displayed in the `Documentation` field.
32
 
 
 
 
 
 
 
 
 
 
 
 
33
  ## Tech Stack Used
34
  ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
35
  ![Azure](https://img.shields.io/badge/azure_SQL-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)
 
20
  $ -- Run backend
21
  $ uvicorn app:app --reload # For running the FastAPI server
22
  $ -- Run frontend
23
+ $ cd frontend
24
  $ streamlit run app.py # For running the Streamlit App
25
  ```
26
 
 
31
  - Now, you can paste your code in the `Code` field and click on the `Generate Documentation` button.
32
  - The generated documentation will be displayed in the `Documentation` field.
33
 
34
+
35
+ ## Demo and Screenshots
36
+ ##### Demo Screenshot 1
37
+ ![Result 3](assets/results3.jpg)
38
+
39
+ ##### Demo Screenshot 2
40
+ ![Result 2](assets/results2.jpg)
41
+
42
+ ##### Demo Screenshot 3
43
+ ![Result 1](assets/results1.jpg)
44
+
45
  ## Tech Stack Used
46
  ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
47
  ![Azure](https://img.shields.io/badge/azure_SQL-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)