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

Updated Developer documentation (markdown)

Browse Source
This commit is contained in:
Torma Kristóf 2020-11-29 00:47:58 +01:00
parent dc66f21248
commit ef8712cd85
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Developer-documentation.md
View File

@ -10,7 +10,7 @@ Our implementation consists of the following modules:
- **CAFF previewer** / [caff-previewer](https://github.com/UnstableVortexSecurity/caff-previewer): A program written in C that is used to extract a preview (a single frame) from a CAFF file. The extracted preview is saved in .tga (TARGA) format, which is a simple bitmap image format.
- **CAFF previewer wrapper** / [caff-previewer-wrapper](https://github.com/UnstableVortexSecurity/caff-previewer-wrapper): A wrapper written in Python/Flask that provides a simple HTTP interface between CAFF previewer and the web client. The wrapper also converts the extracted preview to PNG using ImageMagick.
- **Web client** / [webshop](https://github.com/UnstableVortexSecurity/webshop): A web client written in Python/Flask. This client implements the user functions.
- **Web application** / [webshop](https://github.com/UnstableVortexSecurity/webshop): A web client written in Python/Flask. This client implements the user functions.
Note: each module is hosted in its own repository.
@ -20,5 +20,5 @@ This module is responsible for extracting previews from CAFF files.
# CAFF previewer wrapper
This module makes communication between the previewer and the web client possible.
# Web client
# Web application
This module provides the web UI for the users.