Spaces:
Runtime error
Runtime error
Merge pull request #3 from HemanthSai7/main
Browse files- README.md +12 -0
- requirements.txt +3 -1
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 |
|
| 35 |
|
|
|
|
| 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 |
+
|
| 38 |
+
|
| 39 |
+
##### Demo Screenshot 2
|
| 40 |
+
|
| 41 |
+
|
| 42 |
+
##### Demo Screenshot 3
|
| 43 |
+
|
| 44 |
+
|
| 45 |
## Tech Stack Used
|
| 46 |
|
| 47 |
|
requirements.txt
CHANGED
|
@@ -1,5 +1,7 @@
|
|
| 1 |
-
fastapi
|
|
|
|
| 2 |
requests
|
|
|
|
| 3 |
python-jose[cryptography]
|
| 4 |
passlib[bcrypt]
|
| 5 |
mysql-connector-python
|
|
|
|
| 1 |
+
fastapi==0.99.1
|
| 2 |
+
uvicorn
|
| 3 |
requests
|
| 4 |
+
pydantic==1.10.12
|
| 5 |
python-jose[cryptography]
|
| 6 |
passlib[bcrypt]
|
| 7 |
mysql-connector-python
|