We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 4d0a68b commit 77df6f0Copy full SHA for 77df6f0
1 file changed
README.md
@@ -14,10 +14,23 @@ Create your dynamodb tables
14
15
Navigate into the project directory
16
17
+### To run from the command line
18
+
19
run ```sh uvicorn app.main:app --reload```
20
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
31
>[!TIP]
32
> 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.
33
34
+### Making API Calls
35
-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