Skip to content

Commit 2d9f4c4

Browse files
hansljelbourn
authored andcommitted
chore(doc): update the instructions for setting up dev env. (#603)
ref. #550
1 parent 5bcf4be commit 2d9f4c4

File tree

2 files changed

+21
-23
lines changed

2 files changed

+21
-23
lines changed

DEV_ENVIRONMENT.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,44 @@
11
# Developer guide: getting your environment set up
22

3-
1. Make sure you have `node` installed with a version at _least_ 4.2.3.
3+
1. Make sure you have `node` installed with a version at _least_ 5.5.0.
44
2. Run `npm install -g angular-cli` to install the Angular CLI.
55
3. Fork the `angular/material2` repo.
66
4. Clone your fork.
77
Recommendation: name your git remotes `upstream` for `angular/material2`
88
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/material2/wiki/Team-git----bash-shortcuts).
99
5. From the root of the project, run `npm install`, then run `npm run typings` to install typescript definitions.
1010

11-
1211
To build the project, run `ng build`.
1312
To watch for changes and automatically rebuild, run `ng build --watch`
1413

1514
To bring up a local server, run `ng serve`. This will automatically watch for changes and rebuild.
1615
After the changes rebuild, the browser currently needs to be manually refreshed.
1716

18-
To run unit tests, run `npm test`.
19-
20-
###Running e2e tests:
21-
22-
To prepare your environment, you'll need to install protractor and selenium.
17+
### Running unit tests
2318

24-
1. Globally install protractor:
19+
To run unit tests, run `npm test` or use the CLI with `ng test`.
2520

26-
```
27-
npm install -g protractor
28-
```
21+
### Running e2e tests
2922

30-
2. Install the correct selenium version with webdriver-manager (this comes with protractor):
23+
To prepare your environment, you'll need to install protractor and selenium.
3124

25+
```bash
26+
# 1. Install the correct selenium version with webdriver-manager (this comes with protractor):
27+
npm run webdriver-manager update
3228
```
33-
webdriver-manager update
34-
```
35-
36-
When running the tests:
3729

38-
1. Spin up a local server with `ng serve`.
30+
In order to run the tests:
3931

40-
2. Run tests with:
32+
```bash
33+
# 1. Spin up a local server with
34+
MD_APP=e2e ng serve
4135

36+
# 2. Run tests with:
37+
ng e2e
4238
```
43-
protractor test/protractor.conf.js
44-
```
4539

46-
Running benchmarks: not yet implemented
47-
Running screenshot diff tests: not yet implemented
40+
### Running benchmarks
41+
Not yet implemented.
42+
43+
### Running screenshot diff tests.
44+
Not yet implemented.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"postinstall": "npm run typings",
1919
"e2e": "protractor",
2020
"inline-resources": "node ./scripts/release/inline-resources.js ./dist/components",
21-
"deploy": "firebase deploy"
21+
"deploy": "firebase deploy",
22+
"webdriver-manager": "webdriver-manager"
2223
},
2324
"version": "2.0.0-alpha.5-2",
2425
"license": "MIT",

0 commit comments

Comments
 (0)