Replace buildstatic.sh with yarn scripts and update README.

Installing JavaScript dependencies is now an explicit step that must be done
after cloning or pulling Votr, same as Python dependencies, not something that
happens automatically.

watchstatic.py was fully replaced by webpack --watch.

By default, only development mode is built. Votr.setDebug() can still switch
between production and development if Votr was built with "yarn buildboth".

Author: TomiBelan

README.md

@@ -21,48 +21,49 @@ based on). **Fladgejt** contains the business logic for various AIS2 tasks and
 knows where to find which buttons and tables. And **Votrfront** is the web app
 that Votr's users interact with.
 
-Running Votr
-------------
+Installing and running Votr
+---------------------------
 
-1.  Install Python 3.4+ and virtualenv. On recent Ubuntu or Debian, use:
+System requirements:
 
-        sudo apt install virtualenv
+*   Install Python 3.4+ and virtualenv. E.g. on Ubuntu 18.04: `sudo apt install
+    virtualenv`
+*   Install [node.js 8+][1]. E.g. on Ubuntu 18.04: `sudo apt install nodejs` \
+    If your distro doesn't have node.js >= 8, or if don't want to install
+    node.js system-wide, you can use nvm or nodeenv. [Read more.][2]
+*   [Install Yarn.][3]
 
-2.  Install node.js and npm. (Some Linux distributions bundle them together in
-    one package.) Check the version: npm 1 and 2 are too old. npm 3 and 4 are
-    probably OK. npm 5+ is ideal, but most Linux distributions don't have it yet
-    (including current Ubuntu and Debian). In that case, you can either:
+[1]: https://nodejs.org/en/download/package-manager/
+[2]: https://github.com/fmfi-svt/votr/wiki/Installation-alternatives
+[3]: https://yarnpkg.com/en/docs/install
 
-    *   Install npm 3 despite its age and hope for the best. E.g. on Ubuntu:
-        `sudo apt install nodejs-legacy npm`.
-    *   Use the unofficial up to date repositories from
-        https://nodejs.org/en/download/package-manager/, and install `nodejs`
-        (not `nodejs-legacy` and `npm`).
+Download and set up Votr:
 
-3.  [Install Yarn.](https://yarnpkg.com/en/docs/install)
+```shell
+git clone https://github.com/fmfi-svt/votr.git
+cd votr
+virtualenv -p python3 venv
+```
 
-4.  Create a virtualenv directory. A virtualenv is an isolated environment that
-    contains Python libraries, so that you don't have to install them
-    system-wide, and each project can use different versions without conflicts.
+Install Votr's dependencies in `votr/venv` and `votr/node_modules`: \
+(Note: Repeat this step every time you pull a new version of Votr, in case they
+were updated.)
 
-        virtualenv -p python3 venv
+```shell
+venv/bin/pip install -r requirements.txt
+yarn install
+```
 
-5.  Activate the virtualenv. (Basically, this just adds `venv/bin` to your
-    current shell's `$PATH`. Instead, you could just use `venv/bin/python`
-    instead of `python`, `venv/bin/pip` instead of `pip`, etc.)
+Run Votr by starting these two commands in separate terminals (they are Votr's
+Python web server and Votr's JavaScript build system):
 
-        source venv/bin/activate
+```shell
+venv/bin/python console.py serve --debug
+```
 
-6.  Install the latest version of `pip` (earlier versions don't support wheels),
-    and then use it to install Python dependencies.
-
-        pip install -U pip
-        pip install -r requirements.txt
-
-7.  Start Votr. Remember to activate the virtualenv first if you haven't done it
-    yet in this terminal.
-
-        ./console.py serve --debug
+```shell
+yarn watch
+```
 
 Contributing to Votr
 --------------------

package.json

@@ -29,6 +29,14 @@
     "webpack": "^4.18.0",
     "webpack-cli": "^3.1.0"
   },
+  "scripts": {
+    "builddev": "webpack --mode=development --progress --display=minimal",
+    "buildprod": "webpack --mode=production --progress --display=minimal",
+    "watch": "webpack --mode=development --progress --display=minimal --watch",
+    "buildboth": "$npm_execpath run builddev && $npm_execpath run buildprod && echo ok_both > votrfront/static/status",
+    "clean": "rm -rf votrfront/static",
+    "distclean": "rm -rf votrfront/static node_modules"
+  },
   "browserslist": "defaults, not dead",
   "babel": {
     "presets": [

votrfront/buildstatic.sh

@@ -80,15 +80,15 @@ def app_response(request, **my_data):
     else:
         return Response('Timed out waiting for webpack.', status=500)
 
+    debug = request.cookies.get('votr_debug')
     if status == 'failed':
         return Response('Webpack build failed.', status=500)
-
-    if not os.path.exists(static_path + 'ok'):
-        return Response('buildstatic failed!', status=500)
-
-    debug = request.cookies.get('votr_debug')
-    with open(static_path + ('jsdeps-dev' if debug else 'jsdeps-prod')) as f:
-        scripts = f.read().split()
+    elif status == 'ok_dev' or (status == 'ok_both' and debug):
+        scripts = ['prologue.dev.js', 'votr.dev.js', 'vendors_votr.dev.js']
+    elif status == 'ok_prod' or (status == 'ok_both' and not debug):
+        scripts = ['prologue.min.js', 'votr.min.js', 'vendors_votr.min.js']
+    else:
+        return Response('Unexpected webpack status.', status=500)
 
     content = template % dict(
         init_json=json.dumps({ 'settings': my_data }).replace('</', '<\\/'),

votrfront/front.py

@@ -1,7 +1,6 @@
 
 import os
 from werkzeug.serving import run_simple
-from .watchstatic import watch_in_background
 
 
 def serve(app, *args):
@@ -17,9 +16,6 @@ def serve(app, *args):
     os.makedirs(app.var_path('oldlogs'), exist_ok=True)
     os.makedirs(app.var_path('sessions'), exist_ok=True)
 
-    if os.getenv('WERKZEUG_RUN_MAIN'):
-        watch_in_background()
-
     app.wrap_static()
     run_simple('127.0.0.1', int(os.getenv('PORT') or 5000), app,
                use_debugger=debug, use_reloader=True, threaded=True)