From f99d845465dc69279cdbf91a08fb02d4dbefc9bd Mon Sep 17 00:00:00 2001
From: davidg73 <david.gunnarsson@univie.ac.at>
Date: Mon, 5 May 2025 16:10:52 +0200
Subject: [PATCH] Adapt README to explain how to start service

---
 README.md | 32 ++++++++++++++------------------
 1 file changed, 14 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..3fe2ef8 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,20 @@
-# README
+# Set Up Local Development
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+You must have Docker installed in order to run this service 
 
-Things you may want to cover:
+1. `git clone` the project onto your local workspace
+2. within the project dir, run `docker build . -t dev/facem-backoffice:latest`
+3. within the project dir, run `docker compose up`
+4. open app under http://localhost:4000/
 
-* Ruby version
+Optionally, you can run `docker compose --profile with email up` in case you want to access locally sent mails with a virtual mailbox through `http://localhost:1080/
 
-* System dependencies
+# Deploy Docker Service on Production Server
 
-* Configuration
+1. `ssh` into the production server
+2. `cd` into _gitlab.phaidra.org/facem/facem-backoffice_
+3. within the project dir, `git pull` if you need to get the newest version
+4. within the project dir, `sudo docker build . -t $IMAGE_NAME -f Dockerfile.production`
+5. within the project dir, `sudo docker-compose -f docker-compose.production.yml up -d`
 
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+Service will now be accessible under https://backoffice.facem.at
\ No newline at end of file
-- 
GitLab