2016-02-09 10:34:27 -08:00
|
|
|
# Developer guide: getting your environment set up
|
|
|
|
|
|
2018-10-31 11:38:17 -07:00
|
|
|
1. Make sure you have `node` installed with a version at _least_ 10.0.0 and `yarn` with a version
|
|
|
|
|
of at least 1.10.0. We recommend using `nvm` to manage your node versions.
|
2018-10-25 00:36:00 +02:00
|
|
|
2. Run `yarn global add gulp` to install gulp.
|
2018-10-31 11:38:17 -07:00
|
|
|
3. Fork the `angular/material2` repo on GitHub.
|
|
|
|
|
4. Clone your fork to your machine with `git clone`.
|
2016-02-09 10:34:27 -08:00
|
|
|
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).
|
2018-10-25 00:36:00 +02:00
|
|
|
5. From the root of the project, run `yarn`.
|
2016-02-09 10:34:27 -08:00
|
|
|
|
|
|
|
|
|
2017-04-25 18:50:47 +02:00
|
|
|
To build Material in dev mode, run `gulp material:build`.
|
|
|
|
|
To build Material in release mode, run `gulp material:build-release`
|
2018-10-25 00:36:00 +02:00
|
|
|
|
|
|
|
|
To bring up a local server, run `gulp serve:devapp`. This will automatically watch for changes
|
2016-09-09 10:55:41 -07:00
|
|
|
and rebuild. The browser should refresh automatically when changes are made.
|
2016-02-09 10:34:27 -08:00
|
|
|
|
2016-09-09 10:55:41 -07:00
|
|
|
### Running tests
|
2016-04-04 13:15:05 -07:00
|
|
|
|
2016-09-09 10:55:41 -07:00
|
|
|
To run unit tests, run `gulp test`.
|
|
|
|
|
To run the e2e tests, run `gulp e2e`.
|
|
|
|
|
To run lint, run `gulp lint`.
|
