From 07c0977aa7ce79358e92bd860de1efc9c9b7d456 Mon Sep 17 00:00:00 2001 From: Alex Muszynski Date: Sat, 14 Jun 2025 11:32:56 -0400 Subject: [PATCH] chore: doc updates --- README.md | 9 +++++++++ backend/README.md | 8 ++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 222fcb5..3244b08 100644 --- a/README.md +++ b/README.md @@ -31,5 +31,14 @@ Has an automatic backup on a CRON that outputs to the root volume. ### How to build? The whole thing should run by using docker. + +```bash +docker compose up +``` + There is a docker-compose file in the root, I would suggest changing the user/password to your db if you ever intend for this to leave your home network. I'm sure there are a lot of other security measures as well, but at the time of writing this I'm not particular about the security for the web application 2 people might view. + +### I have a bug + +If you run into any issues feel free to email me at `alexander.muszynski@gmail.com` with the subject being `BlogSiteGitea: {myissue}` or make an issue on the gitea repo. I may or may not get around to it, I just work on this as I feel like it. diff --git a/backend/README.md b/backend/README.md index 76ac08d..92cc1da 100644 --- a/backend/README.md +++ b/backend/README.md @@ -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.