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

Remove autogenerated bullshit from README.md and add actual infos

This commit is contained in:
Kristóf Tóth 2018-03-09 16:49:11 +01:00
parent ecec5e9bbe
commit 792ad68f8a
1 changed files with 7 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,27 +1,13 @@
# TutorialFrameworkNg
Tutorial Framework Frontend
===========================
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.6.1.
## Building and running with magic starter
## Development server
Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally.
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
This requires the `tutorial-framework-wip` and `tutorial-framework-ng` repositories to have a common parent folder.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Running with yarn
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
Simply execute `yarn start` in the project root.