Skip to content

Commit 5b8d350

Browse files
jelbournhansl
authored andcommitted
docs: update dev env guide (#1198)
1 parent 97a5499 commit 5b8d350

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

DEV_ENVIRONMENT.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,26 @@
11
# Developer guide: getting your environment set up
22

33
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.
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`.
1010

11-
To build the project, run `ng build`.
12-
To watch for changes and automatically rebuild, run `ng build --watch`
1311

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.
1617

17-
### Running unit tests
18+
### Running tests
1819

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`.
2023

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-
```
3924

4025
### Running benchmarks
4126
Not yet implemented.

0 commit comments

Comments
 (0)