Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-02-08 00:28:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix documentation

Browse Source
This commit is contained in:
Dennis Eichhorn 2023-11-09 00:26:38 +00:00
parent c556c725da
commit 3c3f6a76e4
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
general/structure.md
View File

@ -4,7 +4,9 @@ The user request gets passed through the entire application to all modules. The
The routes usually reference endpoints in the module `controllers` which collects the model data through the model `mapper` and creates a partial response `view` with an assigned `template` and the collected model data. The routes usually reference endpoints in the module `controllers` which collects the model data through the model `mapper` and creates a partial response `view` with an assigned `template` and the collected model data.
![Application Flow](Developer-Guide/general/app_flow.drawio.svg) <p class="centerText">
<img alt="Application Flow" src="./Developer-Guide/general/app_flow.drawio.svg">
</p>
In the following only the WebApplication and Application are mentioned as the other components are explained in detail in their respective documentation. In the following only the WebApplication and Application are mentioned as the other components are explained in detail in their respective documentation.
@ -33,4 +35,6 @@ Furthermore the Application also performs a `CSRF` check, defines the `CSP`, aut
A short extract of the database structure can be seen below. Please note that this only contains the very basic tables from a fresh install with very few modules and even then we only included the key tables for simplicity reasons. A short extract of the database structure can be seen below. Please note that this only contains the very basic tables from a fresh install with very few modules and even then we only included the key tables for simplicity reasons.
![Application Flow](Developer-Guide/general/base_uml.drawio.svg) <p class="centerText">
<img alt="Application UML" src="./Developer-Guide/general/base_uml.drawio.svg">
</p>

4
quality/inspections.md
View File

@ -17,7 +17,9 @@ The following automated tests must pass without errors, failures and warnings fo
* `./cOMS/tests/test.sh` * `./cOMS/tests/test.sh`
* see [other checks](#other-checks) below * see [other checks](#other-checks) below
<img width="150px" src="./img/webgrind.jpg"> <img width="150px" src="./img/trace_visualizer.jpg"> <img width="150px" src="./img/sitespeed.jpg"> <img width="150px" src="./img/sitespeed_waterfall.jpg"> <img width="150px" src="./img/codecoverage.jpg"> <img width="150px" src="./img/coverage_analysis.jpg"> <img width="150px" src="./img/metrics.jpg"> <img width="150px" src="./img/phpunit_html.jpg"> <img width="150px" src="./img/phpcs.jpg"> <img width="150px" src="./img/phpstan.jpg"> <img width="150px" src="./img/rector.jpg"> <p class="centerText">
<img width="150px" tabindex="0" src="./Developer-Guide/quality/img/webgrind.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/trace_visualizer.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/sitespeed.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/sitespeed_waterfall.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/codecoverage.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/coverage_analysis.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/metrics.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpunit_html.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpcs.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpstan.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/rector.jpg">
</p>
Alternatively you can simply run the helper script in the Build repository, which executes a few of the above mentioned checks: Alternatively you can simply run the helper script in the Build repository, which executes a few of the above mentioned checks: