From 747ba38d517a79fc4149d0532d87848d2a4c1fc1 Mon Sep 17 00:00:00 2001 From: Hans Larsen Date: Wed, 1 Jun 2016 11:43:42 -0700 Subject: [PATCH] chore(doc): update the instructions for setting up dev env. ref. #550 --- DEV_ENVIRONMENT.md | 41 +++++++++++++++++++---------------------- package.json | 3 ++- 2 files changed, 21 insertions(+), 23 deletions(-) diff --git a/DEV_ENVIRONMENT.md b/DEV_ENVIRONMENT.md index afe2cd6f24a2..2900c15a3d63 100644 --- a/DEV_ENVIRONMENT.md +++ b/DEV_ENVIRONMENT.md @@ -1,6 +1,6 @@ # Developer guide: getting your environment set up -1. Make sure you have `node` installed with a version at _least_ 4.2.3. +1. Make sure you have `node` installed with a version at _least_ 5.5.0. 2. Run `npm install -g angular-cli` to install the Angular CLI. 3. Fork the `angular/material2` repo. 4. Clone your fork. @@ -8,40 +8,37 @@ and `` for your fork. Also see the [team git shortcuts](https://github.com/angular/material2/wiki/Team-git----bash-shortcuts). 5. From the root of the project, run `npm install`, then run `npm run typings` to install typescript definitions. - To build the project, run `ng build`. To watch for changes and automatically rebuild, run `ng build --watch` To bring up a local server, run `ng serve`. This will automatically watch for changes and rebuild. After the changes rebuild, the browser currently needs to be manually refreshed. -To run unit tests, run `npm test`. - -###Running e2e tests: - -To prepare your environment, you'll need to install protractor and selenium. +### Running unit tests -1. Globally install protractor: +To run unit tests, run `npm test` or use the CLI with `ng test`. -``` -npm install -g protractor -``` +### Running e2e tests -2. Install the correct selenium version with webdriver-manager (this comes with protractor): +To prepare your environment, you'll need to install protractor and selenium. +```bash +# 1. Install the correct selenium version with webdriver-manager (this comes with protractor): +npm run webdriver-manager update ``` -webdriver-manager update -``` - -When running the tests: -1. Spin up a local server with `ng serve`. +In order to run the tests: -2. Run tests with: +```bash +# 1. Spin up a local server with +MD_APP=e2e ng serve +# 2. Run tests with: +ng e2e ``` -protractor test/protractor.conf.js -``` -Running benchmarks: not yet implemented -Running screenshot diff tests: not yet implemented +### Running benchmarks +Not yet implemented. + +### Running screenshot diff tests. +Not yet implemented. diff --git a/package.json b/package.json index 30e0ced8891b..1c5b93f7f3af 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,8 @@ "postinstall": "npm run typings", "e2e": "protractor", "inline-resources": "node ./scripts/release/inline-resources.js ./dist/components", - "deploy": "firebase deploy" + "deploy": "firebase deploy", + "webdriver-manager": "webdriver-manager" }, "version": "2.0.0-alpha.5", "license": "MIT",