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

Start writing developer documentation

Browse Source
This commit is contained in:
Bendegúz Gyönki 2020-11-28 19:17:44 +01:00
parent 649d82f412
commit a8e7a2c52a
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Developer-documentation.md
View File

@ -1 +1,21 @@
TODO: write documentation # Overview of the task
The task was to implement a security-critical webshop that can be used to sell and buy animated images stored in a custom format. The webshop has to support CAFF (_CrySyS Animated File Format_). The system consists of a web service and a mobile or web client.
# Overview of the implementation
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 client** / [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.
# CAFF previewer
# CAFF previewer wrapper
# Web client