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 23:24:49 +01:00
parent a56b298582
commit 78f9d14f39
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Developer-documentation.md
View File

@ -8,9 +8,9 @@ During the design phase, we decided to implement a web client.
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 application** / [webshop](https://github.com/UnstableVortexSecurity/webshop): A web client written in Python/Flask. This client implements the user functions.
- **CAFF previewer** / [caff-previewer](https://github.com/UnstableVortexSecurity/caff-previewer/commit/0bad0a112e548418c3051c74f8bc58f6cc403033): 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/commit/18dd8418a62445453cc244a730166de55ebcf588): 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 application** / [webshop](https://github.com/UnstableVortexSecurity/webshop/commit/f42411db1a473c9d303b592868d71456e5497eab): A web client written in Python/Flask. This client implements the user functions.
Note: each module is hosted in its own repository.