Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.9 KB

README.md

File metadata and controls

79 lines (49 loc) · 2.9 KB
Raw

Polymer Server

CircleCI

This is the fundamental project, to serve, experience, and test Polymer components in both development and production environment.

Setup

Prerequisites

First, install node.js and npm.

Second, install Bower globally using npm

npm install -g bower

Install components locally

npm install
bower install

Start the development server

This command serves the app at http://localhost:3030 and provides basic URL routing for the app:

npm run start

Production Build

The polymer build command builds your Polymer application for production, using build configuration options provided by the command line or in your project's polymer.json file.

You can configure your polymer.json file to create multiple builds. This is necessary if you will be serving different builds optimized for different browsers. You can define your own named builds, or use presets. See the documentation on building your project for production for more information.

Builds will be output to a subdirectory under the build/ directory as follows:

build/
  es5/
  bundled/
  unbundled/
  • es5 is a bundled, minified build with a service worker. ES6 code is compiled to ES5 for compatibility with older browsers.
  • bundled is a bundled, minified build with a service worker. ES6 code is served as-is. This build is for browsers that can handle ES6 code - see building your project for production for a list.
  • unbundled is an unbundled, minified build with a service worker. ES6 code is served as-is. This build is for browsers that support HTTP/2 push.

Preview the build

This command serves your app.

npm run start:es5
npm run start:bundled
npm run start:unbundled

Run tests

This command will run Web Component Tester against the browsers currently installed on your machine:

polymer test

If running Windows you will need to set the following environment variables:

  • LAUNCHPAD_BROWSERS
  • LAUNCHPAD_CHROME

Read More here daffl/launchpad

Adding a new view

You can extend the app by adding more views that will be demand-loaded e.g. based on the route, or to progressively render non-critical sections of the application. Each new demand-loaded fragment should be added to the list of fragments in the included polymer.json file. This will ensure those components and their dependencies are added to the list of pre-cached components and will be included in the build.