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

Rewrite README

This commit is contained in:
Kristóf Tóth 2018-03-30 23:42:56 +02:00
parent 635d83e1b3
commit a10b772ac5
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,13 +1,11 @@
Tutorial Framework Frontend
===========================
# frontend-tutorial-framework
## Building and running with magic starter
This is the Angular frontend of TFW.
Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally.
The main component it exposes is the `src/app/services/websocket.service.ts` service – providing an RxJS based communication API with the framework backend – and several pre-implemented components for you to used based on it.
This requires the `tutorial-framework-wip` and `tutorial-framework-ng` repositories to have a common parent folder.
To learn more about the framework see the `baseimage-tutorial-framework` repo. For more on building and running TFW (not just the frontend) consult `test-tutorial-framework`.
## Running with yarn
## Running standalone with yarn
Simply execute `yarn start` in the project root.