|
1 | 1 | # Developer guide: getting your environment set up |
2 | 2 |
|
3 | 3 | 1. Make sure you have `node` installed with a version at _least_ 5.5.0. |
4 | | -2. Run `npm install -g angular-cli` to install the Angular CLI. |
| 4 | +2. Run `npm install -g gulp` to install gulp. |
5 | 5 | 3. Fork the `angular/material2` repo. |
6 | 6 | 4. Clone your fork. |
7 | 7 | Recommendation: name your git remotes `upstream` for `angular/material2` |
8 | 8 | and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/material2/wiki/Team-git----bash-shortcuts). |
9 | 9 | 5. From the root of the project, run `npm install`. |
10 | 10 |
|
11 | | -To build the project, run `ng build`. |
12 | | -To watch for changes and automatically rebuild, run `ng build --watch` |
13 | 11 |
|
14 | | -To bring up a local server, run `ng serve`. This will automatically watch for changes and rebuild. |
15 | | -After the changes rebuild, the browser currently needs to be manually refreshed. |
| 12 | +To build the components in dev mode, run `gulp build:components`. |
| 13 | +To build the components in release mode, run `gulp build:release` |
| 14 | + |
| 15 | +To bring up a local server, run `gulp serve:devapp`. This will automatically watch for changes |
| 16 | +and rebuild. The browser should refresh automatically when changes are made. |
16 | 17 |
|
17 | | -### Running unit tests |
| 18 | +### Running tests |
18 | 19 |
|
19 | | -To run unit tests, run `npm test` or use the CLI with `ng test`. |
| 20 | +To run unit tests, run `gulp test`. |
| 21 | +To run the e2e tests, run `gulp e2e`. |
| 22 | +To run lint, run `gulp lint`. |
20 | 23 |
|
21 | | -### Running e2e tests |
22 | | - |
23 | | -To prepare your environment, you'll need to install protractor and selenium. |
24 | | - |
25 | | -```bash |
26 | | -# 1. Install the correct selenium version with webdriver-manager (this comes with protractor): |
27 | | -npm run webdriver-manager update |
28 | | -``` |
29 | | - |
30 | | -In order to run the tests: |
31 | | - |
32 | | -```bash |
33 | | -# 1. Spin up a local server with |
34 | | -MD_APP=e2e ng serve |
35 | | - |
36 | | -# 2. Run tests with: |
37 | | -ng e2e |
38 | | -``` |
39 | 24 |
|
40 | 25 | ### Running benchmarks |
41 | 26 | Not yet implemented. |
|
0 commit comments