unstablevortex/webshop-design
3
0
Fork 0
Code Pull Requests Releases Wiki Activity

Updated Developer documentation (markdown)

Browse Source
This commit is contained in:
Bendegúz Gyönki 2020-11-29 17:00:49 +01:00
parent 730c480649
commit fb3c2c54c0
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Developer-documentation.md
View File

@ -15,15 +15,21 @@ Our implementation consists of the following modules:
Note: each module is hosted in its own repository.
# CAFF previewer
This module is responsible for extracting previews from CAFF files.
This module is responsible for extracting previews from CAFF files. The module can be built using CMake, detailed instructions are available in the module's [README file](https://github.com/UnstableVortexSecurity/caff-previewer/blob/master/README.md).
## Error handling
Functions that perform a complex task can fail in multiple ways. In order to be able to pinpoint the exact issue, these functions always have to return with a status code. The type of the status code is `uint8_t`.
Successful execution is indicated by the status code `0x00`. Any outputs of the function must be returned using pointers given in the parameters. The status code is almost always used as an exit code for the program, so users can easily identify the exact issue.
Each error type must have a status code that is unique in the whole program. The status codes are divided into two parts:
- First 4 bits: identifies a certain module of the previewer
- Last 4 bits: identifies the exact problem
# CAFF previewer wrapper
This module makes communication between the previewer and the web client possible.
# Web application
This module provides the web UI for the users.
# Trying out our webshop
Since our webshop is a modern web application it has quite a few dependencies. To make trying it out easier we deployed to our own secure Kubernetes cluster. It is available at https://unstablevortex.kmlabz.com/ .
The application connects to every dependency (Minio, Caff Previewer Wrapper, SMTP and PostgreSQL server) over TLS and the configuration environment variables are stored in Vault.