Adhin commited on
Commit
dde4124
Β·
1 Parent(s): 149adfe

add readme.md

Browse files
Files changed (1) hide show
  1. README.md +27 -11
README.md CHANGED
@@ -1,11 +1,27 @@
1
- ---
2
- title: Test
3
- emoji: πŸ‘€
4
- colorFrom: purple
5
- colorTo: red
6
- sdk: docker
7
- pinned: false
8
- license: apache-2.0
9
- ---
10
-
11
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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)