Skip to content
This repository has been archived by the owner on Oct 6, 2020. It is now read-only.

Latest commit

 

History

History
27 lines (18 loc) · 930 Bytes

DEV_ENVIRONMENT.md

File metadata and controls

27 lines (18 loc) · 930 Bytes

Developer guide: getting your environment set up

  1. Make sure you have node installed with a version at least 5.5.0.
  2. Run npm install -g gulp to install gulp.
  3. Fork the md2 repo.
  4. Clone your fork. Recommendation: name your git remotes upstream for md2 and <your-username> for your fork. Also see the team git shortcuts.
  5. From the root of the project, run npm install.

To build the components in dev mode, run gulp build:components. To build the components in release mode, run gulp build:release

To bring up a local server, run gulp serve:devapp. This will automatically watch for changes and rebuild. The browser should refresh automatically when changes are made.

Running tests

To run lint, run gulp lint.

Running benchmarks

Not yet implemented.

Running screenshot diff tests

Not yet implemented.