mirror of
https://github.com/avatao-content/baseimage-tutorial-framework
synced 2024-11-22 21:31:31 +00:00
Remove obsolete information from README
This commit is contained in:
parent
7c9ffde932
commit
0a1918ceb6
15
README.md
15
README.md
@ -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.
|
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
|
Simply issue `docker build -t baseimage-tutorial-framework .` in the project root.
|
||||||
Python package from source.
|
|
||||||
|
|
||||||
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.
|
Documentation in progress...
|
||||||
|
|
||||||
## Frontend
|
|
||||||
|
|
||||||
Place an `index.html` and related static files in `src/frontend/dist`, the web server will serve them.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user