Skip to content

Commit e7705e1

Browse files
author
Cecilia Wong
committed
Update README.
1 parent 0ce5e62 commit e7705e1

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,14 @@ Includes:
1313
- Reference: <https://pypi.org/project/swagger-ui-py/>
1414

1515
## Usage
16-
### Startup
1716

18-
The app must be up and running in order for web service calls and the link to the API documentation to work.
17+
**IMPORTANT: The app must be up and running in order for these links to work.**
18+
19+
Root URL: <http://localhost:5000/>
20+
21+
For the list of endpoints, see the Swagger UI API documentation at <http://localhost:5000/api/doc>.
22+
23+
### Startup
1924

2025
#### Run locally at the terminal
2126
1. Go to the root directory of this project in the terminal.
@@ -25,14 +30,19 @@ The app must be up and running in order for web service calls and the link to th
2530

2631
#### Deploy to Docker
2732

28-
You should have Docker Desktop installed at your machine.
33+
**WARNING: This app was designed to be deployed to a machine with Docker Desktop installed. It has not been tested on cloud Docker services and thus is not guaranteed to work there.**
2934

30-
Command: `docker compose up --build -d`
35+
This app may be deployed by either of the following methods:
36+
1. Local deployment at the terminal
37+
- Command: `docker compose up --build -d`
38+
2. Search for image `ccwong4869/python-webservice-demo` and pull
39+
- Public view at Docker Hub: <https://hub.docker.com/r/ccwong4869/python-webservice-demo>
40+
- Note: This image is for the latest version of the `master` branch.
3141

3242
Reference: <https://docs.docker.com/language/python/containerize/>
3343

34-
### To call the services
35-
Base URL: <http://localhost:5000/>
44+
### Testing the deployment with Kubernetes (Docker Desktop)
45+
46+
For commands at the terminal, see: <https://docs.docker.com/language/python/deploy/>
3647

37-
### Swagger UI documentation
38-
<http://localhost:5000/api/doc>
48+
Curl command for verification: `curl http://localhost:30001/`

0 commit comments

Comments
 (0)