baseimage-tutorial-framework/README.md

41 lines
1.5 KiB
Markdown
Raw Normal View History

2017-11-27 19:58:34 +00:00
Tutorial Framework
==================
## Frontend dependencies
These aren't checked in, until the preferred method of dependency management is decided. Until then, they can be
downloaded from the following locations:
* [jQuery](https://jquery.com/download/)
* [Bootstrap](https://getbootstrap.com/docs/4.0/getting-started/download/)
* [Popper.js](https://github.com/FezVrasta/popper.js#installation)
* [Highlight.js](https://highlightjs.org/download/)
* [Showdown](https://github.com/showdownjs/showdown/releases)
* [ace](https://github.com/ajaxorg/ace-builds/releases)
2017-11-27 19:58:34 +00:00
## 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 <id>` to bind the container's port to localhost.
## Running locally
2017-12-08 11:00:51 +00:00
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.
2017-11-27 19:58:34 +00:00
2017-12-08 11:00:51 +00:00
To start the project issue
2017-11-27 19:58:34 +00:00
```
cd src/app/
2017-12-08 11:00:51 +00:00
python app.py
2017-11-27 19:58:34 +00:00
```
2017-12-08 11:00:51 +00:00
in one terminal, and
2017-11-27 19:58:34 +00:00
```
cd src/components/
2017-12-08 11:00:51 +00:00
python event_handler_main.py
2017-11-27 19:58:34 +00:00
```
2017-12-08 11:00:51 +00:00
in another. Prepend the python commands with `PYTHONPATH="../../lib/"` if the folder weren't added to the PYTHONPATH
permanently.