Developer guide

April 24, 2020 ยท View on GitHub

Setup your development environment

  1. Make sure you have both node and yarn installed.
  2. Angular MDC uses Bazel which requires certain Bash and UNIX tools.
    • On Windows: Follow the instructions to install MSYS2 and the listed "Common MSYS2 packages". Afterwards add C:\msys64\usr\bin to the PATH environment variable.
  3. Fork the angular-mdc/web repo on GitHub.
  4. Clone your fork to your machine with git clone.
  5. From the root of the project, run yarn to install the dependencies.

Run demo application

From the root of the project,

yarn demo-app

After your development server is running, open a browser to url: http://localhost:4200

Linting

From the root of the project,

yarn lint # Lints typescript using tslint
yarn lint:css # Lints (S)CSS using stylelint

Testing / Coverage Enforcement

From the root of the project,

yarn test:watch # Runs karma on ChromeHeadless, re-running when source files change
yarn test # Runs karma, and then runs coverage enforcement checks a single time

Build release

From the root of the project,

yarn build # Builds Angular MDC inside of dist/releases/packages

Code Style

We follow Google's JavaScript Style Guide and our entire coding style is enforced automatically through the use of linters.