From 22e7ac2a972f2e7ea517a55d182ecfc4aa916f09 Mon Sep 17 00:00:00 2001 From: zwnk Date: Thu, 16 Jan 2025 15:50:44 -0300 Subject: [PATCH] README updated --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a587db2..bbfbffd 100644 --- a/README.md +++ b/README.md @@ -16,18 +16,28 @@ Clone the 3 repos into the folder: ## SSH git clone via docker compose Have a valid ssh key pair with the Git server provider. + adjust the path to the frontend and backend repos inside `docker-compose_ssh_git.yml` + + run ```docker compose build -f docker-compose_ssh_git.yml --ssh default``` this path is tricky because you have to do more to make the ssh keys working with the docker compose instance. ## how to start the application Adjust the .env files. + + run: ```docker compose up --build``` + + run: ```docker-compose exec backend python manage.py createsuperuser``` and create a user in the backend. + the frontend runs on http://localhost:5173 -local dev: +### local dev: enables live updates of the code during development, no rebuild needed: + + ```docker-compose -f docker-compose.yml -f docker-compose.override.yml up```