summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschneefux <schneefux+commit@schneefux.xyz>2018-05-07 09:58:54 +0200
committerschneefux <schneefux+commit@schneefux.xyz>2018-05-07 09:58:54 +0200
commite2f6fd89c18f943969ffa1abf75d5e074152fb4d (patch)
treec2c521912688353c6a439f717dd9bf3c81f6c6a3
parent1b980682ec71e9c1997747c440a6ad14e31beaf9 (diff)
downloadbrokentalents-e2f6fd89c18f943969ffa1abf75d5e074152fb4d.tar.gz
brokentalents-e2f6fd89c18f943969ffa1abf75d5e074152fb4d.zip
document the backend a lil bit
-rw-r--r--README8
-rw-r--r--assets/backend-flow.pngbin0 -> 44299 bytes
2 files changed, 8 insertions, 0 deletions
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
--- /dev/null
+++ b/assets/backend-flow.png
Binary files differ