mrtoth
/
baseimage-tutorial-framework
mirror of https://github.com/avatao-content/baseimage-tutorial-framework
1
0
Fork 0
Code Issues Releases Wiki Activity

Remove obsolete information from README

This commit is contained in:
Kristóf Tóth 2018-03-23 15:24:30 +01:00
parent 7c9ffde932
commit 0a1918ceb6
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,17 +5,12 @@ Tutorial Framework
Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally.
This requires the `tutorial-framework-wip` and `tutorial-framework-ng` repositories to have a common parent folder.
This requires the `test-tutorial-framework` (Docker image `FROM baseimage-tutorial-framework`) and `frontend-tutorial-framework` repositories to have a common parent folder.
## Building and running with Docker
## Building with Docker
Simply issue `docker build -t tfw .` in the project root. The first build could take a while as it's compiling a fresh
Python package from source.
Simply issue `docker build -t baseimage-tutorial-framework .` in the project root.
Run with `docker run --rm -p 8888:8888 -e AVATAO_SECRET=secret tfw`.
## Creating child images
Running locally is possible with lots of pain involved, so this is no longer officially supported.
## Frontend
Place an `index.html` and related static files in `src/frontend/dist`, the web server will serve them.
Documentation in progress...