Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.4 KB

README.md

File metadata and controls

65 lines (40 loc) · 1.4 KB

The Times Budget Treemap

Polymer component for The Times' Budget 2017 D3 treemap

Getting started

To run this code locally:

  1. Clone this GitHub repository

  2. Install the dependencies

$ npm install && bower install
  1. Start the development server
$ npm run start

To create a built version of the component, run:

$ npm run dist

Contact

Structure

The app/times-treemap folder contains three files that comprise the web component:

  • index.html for the component's HTML structure
  • script.js for the component logic, which should be built around Polymer's lifecycle hooks
  • style.scss for the component's styles (as SASS)

Testing

Web Component Tester (WCT) is included to support testing. Tests can be written in test/times-treemap.html.

Settings can be tweaked in wct.conf.json.

Dependencies

Third-party components can be included using Bower (as mandated by Polymer).

Build process

On npm run build, the separate component files will be bundled together and then Vulcanized, which inlines dependencies.

To prevent a dependency being inlined (for example, if the dependency is hosted on the Times components server) you can add it to the excludes array in scripts/vulcanize.js.

Polymer itself should always be excluded from the Vulcanize process.