docs

.gitignore

@@ -1,5 +1,5 @@
 __pycache__/
 ENV
-./api/config/dbconfig.ini
+api/config/dbconfig.ini
-./api/config/authservice.pub
+api/config/authservice.pub
 

api/run.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-. ENV
-
-IMAGE_NAME="registry.hottis.de/hv2/hv2-api"
-VERSION=0.0.x
-
-
-docker run \
-    -d \
-    --rm \
-    --name "hv2-api" \
-    -p 5000:5000
-    ${IMAGE_NAME}:${VERSION}

readme.md

@@ -1,4 +1,6 @@
 * all tools provide should work on Linux and on Windows, shell scripts are avoided
 * templates files must be generated at development time, generated files must be put into the repository
 * use ``generate.py`` in the umbrella project's root without any arguments to generate all template files in all subdirectories using the ``schema.json`` from the umbrella project's root
-* to start the API set the required env variables (see ``ENV.tmp``) and run ``test.py`` from the API subproject
+* to start the API set the required env variables (see ``ENV.tmp``) or the configuration files in the subdirectory ``./config`` and run ``test.py`` from the API subproject
+* make sure these configuration files are not added to the repository, they contain secrets
+