mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-22 20:01:33 +00:00
Code Issues Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Bálint Bokros 2018-01-10 16:56:03 +01:00
parent a4d101883e
commit c26d3da98d
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,20 +1,21 @@
Tutorial Framework Tutorial Framework
================== ==================
## Frontend dependencies ## Frontend
Open up a terminal in `src/app/static`. Issue `yarn install` to install dependencies and `webpack` to compile the Place an `index.html` and related static files in `src/frontend/dist`, the web server will serve them properly.
frontend source.
## Building and running with Docker ## 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 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. Python package from source. Subsequent builds can reuse this layer, so their execution time is significantly shorter.
Run with `docker run -p 4242:4242 <id>` to bind the container's port to localhost. Run with `docker run -p 8888:8888 <id>` to bind the container's port to localhost.
## Running locally ## Running locally
_This will probably barf at the moment._
Create a new virtualenv, preferably with [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io). Install the 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 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. the project root to add the local libraries to the virtualenv's PYTHONPATH.