Skip to content

Commit 6c3b46d

Browse files
Merge pull request #43 from shadab-mohammad-oracle/patch-5
Update README.md
2 parents 9f02031 + 5df16ea commit 6c3b46d

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,66 @@ curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
116116
### 📌 URL - HTTPS | HTTP
117117
- Check Public or Private URLs for latency
118118

119+
# Bonus
120+
## Stop and Start Shell Scripts (Linux and macOS) ##
121+
122+
- `start.sh`: Activates the Python virtual environment and launches uvicorn with HTTPS, using the generated self-signed certificate.
123+
- `stop.sh`: Finds and terminates any uvicorn process running your app cleanly and safely.
124+
125+
Stop the Delta App
126+
```bash
127+
bash stop.sh
128+
```
129+
130+
Start the Delta App
131+
```bash
132+
bash start.sh
133+
```
134+
135+
## Windows Build File (Beta: Not tested)
136+
137+
Yes, you must first download (clone or extract) the GitHub repo to your Windows machine.
138+
139+
__Instructions:__
140+
141+
1. __Download the Repository__
142+
143+
- If you have Git installed:
144+
145+
- Open Command Prompt or PowerShell.
146+
- Run:
147+
148+
```javascript
149+
git clone https://github.com/oracle-quickstart/db-endpoint-latency-testing-ammeter.git
150+
cd db-endpoint-latency-testing-ammeter
151+
```
152+
153+
- Or download the zip from the GitHub releases or code page, and extract all files to a folder.
154+
155+
2. __Run the Build Script__
156+
157+
- In Command Prompt (NOT PowerShell), navigate to the project folder.
158+
- Run:
159+
160+
```javascript
161+
build_windows.bat
162+
```
163+
164+
- This script will:
165+
166+
- Create a virtual environment
167+
- Install dependencies
168+
- Generate a self-signed SSL certificate
169+
- Launch the app on [](https://localhost:8000)<https://localhost:8000>
170+
171+
__Requirements on Windows:__
172+
173+
- Python 3 (with pip)
174+
- openssl.exe in PATH (commonly included with Git Bash or available at [slproweb.com](https://slproweb.com/products/Win32OpenSSL.html))
175+
176+
You do not need to manually install anything except Python and openssl; the script handles the rest.
177+
178+
119179
## Contributing
120180

121181
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)