hv2-all-in-one/readme.md

19 lines
873 B
Markdown
Raw Normal View History

2021-08-29 13:39:04 +02:00
# Developing in HV2 umbrella project
## Tools and Templates
2021-08-29 12:58:45 +02:00
* 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
2021-08-29 13:39:04 +02:00
## Subprojects
### API
2021-08-29 13:16:50 +02:00
* 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
2021-08-29 13:39:04 +02:00
* in the development environment the API will answer at ``http://localhost:8080``, the Swagger-UI is available at ``http://localhost:8080/ui``
2021-08-29 13:16:50 +02:00
2022-05-06 23:59:47 +02:00