Skip to content

docs: update dev environment instructions #18359

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
Feb 4, 2020
Merged

docs: update dev environment instructions #18359

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
16 changes: 7 additions & 9 deletions DEV_ENVIRONMENT.md
View file
Open in desktop
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`.