diff options
| author | schneefux <schneefux+commit@schneefux.xyz> | 2018-05-07 09:59:23 +0200 |
|---|---|---|
| committer | schneefux <schneefux+commit@schneefux.xyz> | 2018-05-07 09:59:23 +0200 |
| commit | 9f12ba674bb824627ceb648e79a2fa7065a1e51d (patch) | |
| tree | 93d76e6d2864f24ce939e570a1ffe41eec889241 /README.md | |
| parent | e2f6fd89c18f943969ffa1abf75d5e074152fb4d (diff) | |
| download | brokentalents-9f12ba674bb824627ceb648e79a2fa7065a1e51d.tar.gz brokentalents-9f12ba674bb824627ceb648e79a2fa7065a1e51d.zip | |
make markdown readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd24adc --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# brokentalents.fun + +## Setup + + * `npm install` + * create backend/secret.js as `module.exports.apikey = 'yourapikey';` or export the env var `API_KEY=""` + +## Updating the data + +`npm run backend` + +## Overview + + + +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. |