summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorschneefux <schneefux+commit@schneefux.xyz>2018-05-08 11:02:48 +0200
committerschneefux <schneefux+commit@schneefux.xyz>2018-05-08 11:02:48 +0200
commit6305acef3bd25f51b408b38a9f4f11c3040480c5 (patch)
treef8d45885f66ef85eb1bd4079034e8bd72fdba0d3 /README.md
parent9f12ba674bb824627ceb648e79a2fa7065a1e51d (diff)
downloadbrokentalents-6305acef3bd25f51b408b38a9f4f11c3040480c5.tar.gz
brokentalents-6305acef3bd25f51b408b38a9f4f11c3040480c5.zip
frontend template setup
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index bd24adc..5269578 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,19 @@
`npm run backend`
+## 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](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.