README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# 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`

`parallel -eta convert {} {.}.jpg ::: dist/assets/*/*/*.png`

## Building the frontend

 * production: `npm run build`
 * development: `npm run dev`

## Overview

### Frontend

The frontend is written with the [Vue](https://vuejs.org) JavaScript framework and the [Bulma](https://bulma.io) CSS framework using [Buefy](https://buefy.github.io), built by [Webpack](https://webpack.js.org) with [Babel](https://babeljs.io) for cross browser support. It is hosted on GitHub pages.

### Backend

![backend flowchart](dist/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.