Skip to content

Commit 77df6f0

Browse files
authored
Update README.md
1 parent 4d0a68b commit 77df6f0

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,23 @@ Create your dynamodb tables
1414

1515
Navigate into the project directory
1616

17+
### To run from the command line
18+
1719
run ```sh uvicorn app.main:app --reload```
1820

21+
22+
### To run with Docker compose
23+
24+
>[!TIP]
25+
> You will need access to the aws config variables through a .env file or using EXPORT from the command line
26+
27+
Use the `Makefile` command `make build`
28+
29+
### Docs
30+
1931
>[!TIP]
2032
> Once that is running docs can be found at http://127.0.0.1:8000/docs where they are kindly generated for us by FastApi using openapi.
2133
34+
### Making API Calls
2235

23-
Curl Commands for all api calls can be found there or in the docstrings on the routes.
36+
Curl Commands for all api calls can be found there or in the docstrings on the routes.

0 commit comments

Comments
 (0)