diff --git a/README.md b/README.md new file mode 100644 index 0000000..d1d5776 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# PreSnax +## Middleware between Engelsystem & Pretix for Angel Food Distribution + +simple middleware supposed to sit between a pretix and a system like Engelsystem to provide volunteers with an option to get a food voucher. + +This middleware is specifically designed to work with the C3 setup. + +## Pretix Setup: + +- event series, each meal is one slot in the event series +- 3 different products (crew, regular & override) +- set quotas +- generate API key + + +## Software Setup + +- define meals +- define product types & the respective product id's +- define endpoint, api key, etc. +- define mail server +- generate auth token + +## Features + +expects a json post request: + +``` +{ + "email": "foobar@example.org", + "type": "regular", + "meal": "tag4mittag" +} +``` + +books the respective ticket (if available) and sends it to the specified email. + +The ticket is booked with a dummy mail address (currently hardcoded) + +if you book a ticket with %something%@printme.local it won't send an email but will answer with the qrcode as response. This is implemented for the [GUI](https://git.cccv.de/thies/presnax-gui) that can override Engelsystem. + + +