This project is setup to build on every push, the dependencies follow:
impl/
folder containing the Python package implementation.test/
folder containing unit tests for all modules. These can all be run using the commandmake test
, and are run automatically on each push.scripts/
folder containing helpful scripts, some of which are called by other files.webgui/
folder containing the Flask web application and templates.
- Install and start a local docker-machine.
- Run
pip3 install .
in the root directory to install theimpl
package. - Run
source scripts/env.sh
in the root directory to setup flask app. - Run
flask run
in the root directory.
- Clone repository to directory.
- If using virtualenv initialize here. See documentation.
- Run
docker build -t local_build .
[run in cloud build].
- Run
docker run --publish=5000:5000 -ti local_build:latest flask run --host=0.0.0.0
if running through container. To run over https rundocker run --publish=5000:5000 -ti local_build:latest flask run --cert=adhoc --host=0.0.0.0
. - Navigate to webpage shown at prompt.
- Enjoy!