Updated README and scripts

.scripts/docker-prune.sh

-#!/bin/bash
-if [[ "$CI_COMMIT_BRANCH" =~ (dev|master) ]]; then
-  echo "pruning for branch ${CI_COMMIT_BRANCH} ..."
-  docker system prune -f -a --volumes
-fi
\ No newline at end of file

Makefile

@@ -28,9 +28,7 @@ build-analyse-service:
 	bash ./dbrepo-analyse-service/build.sh
 
 build-docker:
-	docker build --network=host -t dbrepo-metadata-service:build --target build dbrepo-metadata-service
-	docker build --network=host -t dbrepo-data-service:build --target build dbrepo-data-service
-	docker compose build --parallel
+	bash ./bin/build-docker.sh
 
 build-frontend:
 	yarn --cwd ./dbrepo-ui install --legacy-peer-deps
@@ -220,7 +218,7 @@ test-clients:
 test: test-backend test-frontend
 
 teardown:
-	./.scripts/teardown.sh
+	./bin/teardown.sh
 
 docs: build-docker
 	docker compose up -d || docker compose down

README.md

@@ -3,7 +3,7 @@
 [![license](.gitlab/license.svg)](https://opensource.org/licenses/Apache-2.0)
 [![release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/badges/release.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags)
 
-<img src="./dbrepo-ui/static/logo.png" alt="DBREPO &mdash; Repository for Data in Databases" width="200" />
+![DBRepo &mdash; Repository for Data in Databases](./.gitlab/logo.png)
 
 ## tl;dr
 
@@ -14,16 +14,62 @@ with:
 curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/install.sh | bash
 ```
 
+## Run
+
+tbd
+
 ## Documentation
 
 Find a system description, component documentation and endpoint documentation 
 online: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/.
 
-## Contribute
+## Development
 
 Contributions are always welcome and encouraged, please read the [contribution overview](./CONTRIBUTING.md) and
 contact [Prof. Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/) or [Martin Weise](https://ec.tuwien.ac.at/~weise/).
 
+### Build
+
+Install the build dependencies under Debian 
+12 ([Instructions for Docker Engine](https://docs.docker.com/engine/install/debian/#install-using-the-repository)):
+
+```console
+$ apt install -y bash maven openjdk-17-jdk nodejs && npm install --global yarn
+$ node --version
+v18.19.0
+```
+
+Build the Docker containers:
+
+```console
+./bin/build-docker.sh
+```
+
+### Test
+
+Install the [build dependencies](#build) as they also cover the test dependencies.
+
+Test the backend and frontend:
+
+```console
+./bin/test.sh
+```
+
+## Run
+
+After [building the docker containers](#build) you can run them using the default `docker-compose.yml` in the root of
+the sourcecode directory. This starts all services in the background (as daemons hence the `-d` flag).
+
+```console
+$ docker compose up -d
+```
+
+Optionally view all logs in real-time:
+
+```console
+$ docker compose logs -f
+```
+
 ## Acknowledgements
 
 We want to thank the following organizations:

bin/build-docker.sh

+#!/bin/bash
+docker build -t dbrepo-metadata-service:build --target build dbrepo-metadata-service
+docker build -t dbrepo-data-service:build --target build dbrepo-data-service
+docker compose build --parallel
\ No newline at end of file

bin/test.sh

+#!/bin/bash
+mvn -f ./dbrepo-metadata-service/pom.xml clean install -DskipTests
+# test java services
+mvn -f ./dbrepo-metadata-service/pom.xml clean test verify
+mvn -f ./dbrepo-data-service/pom.xml clean test verify
+# test python services
+bash ./dbrepo-analyse-service/test.sh
+bash ./dbrepo-search-service/test.sh
+# test ui
+yarn --cwd ./dbrepo-ui install
+yarn --cwd ./dbrepo-ui run test:unit
+yarn --cwd ./dbrepo-ui run coverage
\ No newline at end of file

requirements.txt

-mkdocs==1.4.3
-mkdocs-material==9.1.17
-mkdocs-with-pdf==0.9.3
-mkdocs-material-extensions>=1.0.3
-requests>=2.27.0
-py-dotenv>=0.1
-python-dotenv==1.0.0
-requests==2.31.0
\ No newline at end of file