Spaces:
Paused
Paused
add readme.md
Browse files
README.md
CHANGED
|
@@ -1,11 +1,27 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# π FastAPI Application
|
| 2 |
+
|
| 3 |
+
This is a RESTful API built using [FastAPI](https://fastapi.tiangolo.com/)
|
| 4 |
+
## π οΈ Installation
|
| 5 |
+
|
| 6 |
+
1. **Clone the repository**:
|
| 7 |
+
> git clone https://huggingface.co/spaces/Adhin/HemoVDB
|
| 8 |
+
|
| 9 |
+
1. **Create a virtual environment**:
|
| 10 |
+
> python -m venv venv
|
| 11 |
+
On Windows: venv\Scripts\activate
|
| 12 |
+
|
| 13 |
+
1. **Install dependencies**:
|
| 14 |
+
pip install -r requirements.txt
|
| 15 |
+
|
| 16 |
+
## π Running the Application
|
| 17 |
+
|
| 18 |
+
> uvicorn main:app --reload
|
| 19 |
+
|
| 20 |
+
By default, the app will be available at `http://127.0.0.1:8000/`.
|
| 21 |
+
|
| 22 |
+
## π API Documentation
|
| 23 |
+
|
| 24 |
+
FastAPI provides two interactive API docs out-of-the-box:
|
| 25 |
+
|
| 26 |
+
- Swagger UI: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
|
| 27 |
+
- ReDoc: [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)
|