From 792ad68f8acd71971fb14326477b6925dda927c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 9 Mar 2018 16:49:11 +0100 Subject: [PATCH] Remove autogenerated bullshit from README.md and add actual infos --- README.md | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 627549b..06adc59 100644 --- a/README.md +++ b/README.md @@ -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.