Skip to content

Commit 22d7cf6

Browse files
authored
docs: update dev environment instructions (#18359)
Updates the dev environment instructions to mention how to run tests properly. Also removes global Gulp as a required step for setting up the environment and changes the Gulp commands to go through yarn.
1 parent 058198a commit 22d7cf6

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

DEV_ENVIRONMENT.md

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

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.
55
2. angular/components uses Bazel which requires certain Bash and UNIX tools.
66
- On Windows: Follow the [instructions](https://docs.bazel.build/versions/master/install-windows.html#5-optional-install-compilers-and-language-runtimes)
77
to install [`MSYS2`](https://www.msys2.org/) and the listed "Common MSYS2 packages".
88
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`.
1211
Recommendation: name your git remotes `upstream` for `angular/components`
1312
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.
1514

1615

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

2018
To bring up a local server, run `yarn dev-app`. This will automatically watch for changes
2119
and rebuild. The browser should refresh automatically when changes are made.
2220

2321
### Running tests
2422

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`.
2624
To run the e2e tests, run `yarn e2e`.
2725
To run lint, run `yarn lint`.

0 commit comments

Comments
 (0)