forked from angular/components
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update dev environment instructions (angular#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.
- Loading branch information
Showing
1 changed file
with
7 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,25 @@ | ||
# Developer guide: getting your environment set up | ||
|
||
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. | ||
1. Make sure you have both `node` and `yarn` installed. | ||
We recommend using `nvm` to manage your node versions. | ||
2. angular/components uses Bazel which requires certain Bash and UNIX tools. | ||
- On Windows: Follow the [instructions](https://docs.bazel.build/versions/master/install-windows.html#5-optional-install-compilers-and-language-runtimes) | ||
to install [`MSYS2`](https://www.msys2.org/) and the listed "Common MSYS2 packages". | ||
Afterwards add `C:\msys64\usr\bin` to the `PATH` environment variable. | ||
3. Run `yarn global add gulp` to install gulp. | ||
4. Fork the `angular/components` repo on GitHub. | ||
5. Clone your fork to your machine with `git clone`. | ||
3. Fork the `angular/components` repo on GitHub. | ||
4. Clone your fork to your machine with `git clone`. | ||
Recommendation: name your git remotes `upstream` for `angular/components` | ||
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts). | ||
6. From the root of the project, run `yarn`. | ||
5. From the root of the project, run `yarn` to install the dependencies. | ||
|
||
|
||
To build angular/components in dev mode, run `gulp material:build`. | ||
To build angular/components in release mode, run `gulp material:build-release` | ||
To build angular/components in release mode, run `yarn build`. The output can be found under `dist/releases`. | ||
|
||
To bring up a local server, run `yarn dev-app`. This will automatically watch for changes | ||
and rebuild. The browser should refresh automatically when changes are made. | ||
|
||
### Running tests | ||
|
||
To run unit tests, run `yarn test`. | ||
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`. | ||
To run the e2e tests, run `yarn e2e`. | ||
To run lint, run `yarn lint`. |