From c26d3da98d995493dee444fe66eba01702d72ce3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1lint=20Bokros?= Date: Wed, 10 Jan 2018 16:56:03 +0100 Subject: [PATCH] Update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f16318a..00cdfbe 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ Tutorial Framework ================== -## Frontend dependencies +## Frontend -Open up a terminal in `src/app/static`. Issue `yarn install` to install dependencies and `webpack` to compile the -frontend source. +Place an `index.html` and related static files in `src/frontend/dist`, the web server will serve them properly. ## Building and running with Docker Simply issue `docker build .` in the root of the project. The first build could take a while as it's compiling a fresh Python package from source. Subsequent builds can reuse this layer, so their execution time is significantly shorter. -Run with `docker run -p 4242:4242 ` to bind the container's port to localhost. +Run with `docker run -p 8888:8888 ` to bind the container's port to localhost. ## Running locally +_This will probably barf at the moment._ + Create a new virtualenv, preferably with [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io). Install the dependencies with `pip install tornado pyzmq transitions`. If using virtualenvwrapper, issue `add2virtualenv lib` from the project root to add the local libraries to the virtualenv's PYTHONPATH.