From 5412b6d034a638506be2cc05c50517175e4e2291 Mon Sep 17 00:00:00 2001 From: Evan Langlais Date: Fri, 25 Jan 2019 16:26:28 -0500 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0e8d974..dc313e8 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,18 @@ -# Frontend +# PowerPanel Frontend This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.2.4. -## Development server +## Installation +1. Ensure you have npm installed +2. Clone repository into new folder +3. In terminal / CMD run npm install -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. - -## 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`. - -## Build +## Development -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. +When developing, ensure you are on a different branch (NOT working on master). -## Running unit tests +Once you have a local instance that seems ready to merge into master, create a pull request. -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +## Local development server -## 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). +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.