Skip to content

chore(doc): update the instructions for setting up dev env. #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 1, 2016
Merged

chore(doc): update the instructions for setting up dev env. #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 19 additions & 22 deletions DEV_ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,44 @@
# 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.
Recommendation: name your git remotes `upstream` for `angular/material2`
and `<your-username>` 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.
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down