From e2f6fd89c18f943969ffa1abf75d5e074152fb4d Mon Sep 17 00:00:00 2001 From: schneefux Date: Mon, 7 May 2018 09:58:54 +0200 Subject: document the backend a lil bit --- README | 8 ++++++++ assets/backend-flow.png | Bin 0 -> 44299 bytes 2 files changed, 8 insertions(+) create mode 100644 assets/backend-flow.png diff --git a/README b/README index ceaad3b..bd24adc 100644 --- a/README +++ b/README @@ -8,3 +8,11 @@ ## Updating the data `npm run backend` + +## Overview + +![backend flowchart](assets/backend-flow.png) + +The `/matches` endpoint is called in equidistant intervals for a small set of matches. An hour of each set is aggregated and stored in a timestamped json. All timestamped jsons are aggregated and generate the output report json. + +The code was written with [Ramda](https://ramdajs.com) as an excercise in functional programming with JavaScript. diff --git a/assets/backend-flow.png b/assets/backend-flow.png new file mode 100644 index 0000000..67bffa8 Binary files /dev/null and b/assets/backend-flow.png differ -- cgit v1.3.1