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

docs(yarn): removed all references of yarn #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 19 additions & 8 deletions README.md
Expand Up @@ -8,32 +8,43 @@ projects. This project is not maintained and only serves as an example. If you'r
in learning more about web components, check out [Open WC](https://open-wc.org)

## How to Set up Your Development Environment

`npm i`
`npm start`
```bash
npm i
npm start
```

## Testing

`yarn test`
```bash
npm test
```

#### JavaScript Unit Testing

Polaris uses [Web Component Tester](https://github.com/Polymer/web-component-tester) as its JavaScript testing framework.
Polaris uses [Web Component Tester](https://github.com/Polymer/tools/tree/master/packages/web-component-tester) as its JavaScript testing framework.

> Install `WCT` globally

```bash
npm install -g web-component-tester
```

You can run WCT using `yarn test` or `wct` - install wct globally first with `yarn global add wct`
You can run WCT using `npm test` or `wct`

#### JavaScript Code Coverage

Polaris uses [Istanbul](http://gotwarlost.github.io/istanbul/) in tracing JavaScript code coverage.

How to generate code coverage:

1. Run a test `yarn test`
1. Run a test `npm test`

2. View the report in your browser:

open coverage/index.html

## Building for Release

`yarn build`
```bash
npm run build
```
1 change: 0 additions & 1 deletion package.json
Expand Up @@ -11,7 +11,6 @@
"build": "node tasks/build.js",
"deploy": "bin/deploy.sh",
"lint": "eslint . --ext js,html --ignore-path .gitignore",
"setup": "yarn",
"start": "node tasks/watch.js",
"test": "wct"
},
Expand Down