NickKalar/LMS-APIs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Nick Kalar
2025-08-26 14:43:47 -04:00
parent 7947690575
commit fee83902d9
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -25,6 +25,7 @@ ktor:
modules: modules:
-codes.kalar.ApplicationKt.module -codes.kalar.ApplicationKt.module
deployment: deployment:
host: <host address> (defaults to `0.0.0.0` if not added)
port: 8080 port: 8080
postgres: postgres:
url: "jdbc:postgresql://<url to database>" url: "jdbc:postgresql://<url to database>"
@@ -53,3 +54,5 @@ If the server starts successfully, you'll see the following output:
``` ```
From here, navigate to http://0.0.0.0:8080/swagger for API documentation. From here, navigate to http://0.0.0.0:8080/swagger for API documentation.
NOTE: the address may change if you have updated the application.yaml file with a new host address.