chore: doc updates

2025-06-14 11:32:56 -04:00
parent 2c73c3ba4c
commit 07c0977aa7
2 changed files with 17 additions and 0 deletions
@@ -1 +1,9 @@
 # Server
+
+The server is built using FastAPI on port `8000`.
+
+If you are running locally you can view all the apis by navigating to `localhost:8000/docs`
+
+This project uses `sqlalchemy` and `alembic` to access and manage the database which is a `postgresql` instance that is also created during the docker compose step.
+
+I would suggest using docker compose for all testing as that is what I will do, running the server in isolation may have bugs so be cautious.