Skip to content

Commit 357a773

Browse files
Merge pull request #26 from shadab-mohammad-oracle/patch-5
Update README.md
2 parents 802c940 + 24bed4e commit 357a773

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,19 @@ This project is a secure, lightweight SaaS-like database latency testing GUI and
55
https://github.com/user-attachments/assets/e3eaf179-914b-4c17-bc47-35f17e86aee0
66

77

8-
### 1. Clone Repository ###
8+
## Clone Repository ##
99
```bash
1010
git clone https://github.com/oracle-quickstart/db-endpoint-latency-testing-ammeter.git && cd db-endpoint-latency-testing-ammeter/
1111
```
1212

13-
### 2. Create a Python Virtual Environment
13+
## Quick Build with One-Command ##
14+
```bash
15+
bash build.sh
16+
```
17+
18+
## Alternate : Step-by-Step Manual Build ##
19+
20+
### 1. Create a Python Virtual Environment
1421

1522
```bash
1623
python3 -m venv .venv
@@ -26,16 +33,16 @@ source .venv/bin/activate
2633
.venv\Scripts\activate
2734
```
2835

29-
### 3. Install requirements
36+
### 2. Install requirements
3037
```bash
3138
pip3 install -r requirements.txt
3239
```
3340

34-
### 4. Launch the Web App
41+
### 3. Launch the Web App
3542
```bash
3643
uvicorn app.main:app --host 0.0.0.0 --port 8000
3744
```
38-
### 5. Open your browser at:
45+
### 4. Open your browser at:
3946
```
4047
http://localhost:8000
4148
```
@@ -49,7 +56,7 @@ http://localhost:8000
4956

5057
![Screenshot 2025-07-03 at 11 26 30 PM](https://github.com/user-attachments/assets/f1b17fb8-f637-4b86-95c9-52dd0b6e2067)
5158

52-
### 6. API Usage via Curl/CLI Example:
59+
### 5. API Usage via Curl/CLI Example:
5360
```bash
5461
curl -u admin:change_this -X POST http://localhost:8000/api/test-latency -d dbtype=mysql -d host=localhost -d port=3390 -d username=testuser -d password="YOurP@ssword#12" -d database=testdb -d interval=1 -d period=10 | jq .
5562
```

0 commit comments

Comments
 (0)