|
1 | 1 | # Developer guide: getting your environment set up
|
2 | 2 |
|
3 |
| -1. Make sure you have `node` installed with a version at _least_ 10.0.0 and `yarn` with a version |
4 |
| - of at least 1.10.0. We recommend using `nvm` to manage your node versions. |
| 3 | +1. Make sure you have both `node` and `yarn` installed. |
| 4 | + We recommend using `nvm` to manage your node versions. |
5 | 5 | 2. angular/components uses Bazel which requires certain Bash and UNIX tools.
|
6 | 6 | - On Windows: Follow the [instructions](https://docs.bazel.build/versions/master/install-windows.html#5-optional-install-compilers-and-language-runtimes)
|
7 | 7 | to install [`MSYS2`](https://www.msys2.org/) and the listed "Common MSYS2 packages".
|
8 | 8 | Afterwards add `C:\msys64\usr\bin` to the `PATH` environment variable.
|
9 |
| -3. Run `yarn global add gulp` to install gulp. |
10 |
| -4. Fork the `angular/components` repo on GitHub. |
11 |
| -5. Clone your fork to your machine with `git clone`. |
| 9 | +3. Fork the `angular/components` repo on GitHub. |
| 10 | +4. Clone your fork to your machine with `git clone`. |
12 | 11 | Recommendation: name your git remotes `upstream` for `angular/components`
|
13 | 12 | and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts).
|
14 |
| -6. From the root of the project, run `yarn`. |
| 13 | +5. From the root of the project, run `yarn` to install the dependencies. |
15 | 14 |
|
16 | 15 |
|
17 |
| -To build angular/components in dev mode, run `gulp material:build`. |
18 |
| -To build angular/components in release mode, run `gulp material:build-release` |
| 16 | +To build angular/components in release mode, run `yarn build`. The output can be found under `dist/releases`. |
19 | 17 |
|
20 | 18 | To bring up a local server, run `yarn dev-app`. This will automatically watch for changes
|
21 | 19 | and rebuild. The browser should refresh automatically when changes are made.
|
22 | 20 |
|
23 | 21 | ### Running tests
|
24 | 22 |
|
25 |
| -To run unit tests, run `yarn test`. |
| 23 | +To run unit tests, run `yarn test <target>`. The `target` can be either a short name (e.g. `yarn test button`) or an explicit path `yarn test src/cdk/stepper`. |
26 | 24 | To run the e2e tests, run `yarn e2e`.
|
27 | 25 | To run lint, run `yarn lint`.
|
0 commit comments