diff --git a/readme.md b/readme.md index 82ebb17cc6a7ff781ba8a55af21ddaff86269dc1..81b3e9652e682bae42b7c67e21808457a48d4536 100644 --- a/readme.md +++ b/readme.md @@ -49,7 +49,7 @@ Methods should be the same with "`override`" instead of "`virtual`". --- -#### - if files are missing (and only then): +#### If some files are missing (and only then!): Copy them from folder `Controllers`, rename them (append `Impl`) and handle them like the already existing files, i.e.: Change classnames by appending `Impl` to the original classnames (and change filenames accordingly) and inherit from original class in `Controllers` (instead of `ControllerBase`) @@ -110,7 +110,7 @@ open a command shell and generate docker by executing in `server/src/Org.OpenAPI docker build -t org.openapitools . ``` -## How to start: +## How to start The easiest way is to use docker-compose: Open a command shell and use docker-compose (if necessary adapt docker-compose.yml) by executing in `server/src/Org.OpenAPITools`: @@ -120,7 +120,7 @@ Open a command shell and use docker-compose (if necessary adapt docker-compose.y Open http://localhost:8080/openapi/index.html in a web-browser, if you want to check the functionalities using SwaggerUI -## How to stop: +## How to stop Open a command shell by executing in `server/src/Org.OpenAPITools`: ``` docker-compose down @@ -132,7 +132,7 @@ Execute the following command in docker: mongodump --db **insert database_name** --out /data-dump/`date +"%Y-%m-%d"` ``` -## How to import database: +## How to import database Execute the following command in docker: ``` mongorestore --db **insert database_name** **insert path_to_bson_file**