generator-polymer-init-uniflow-polymer-starter-kit

2.0.4 • Public • Published

generator-polymer-init-uniflow-polymer-starter-kit

Build Status

This template is a starting point for building apps using Polymer Starter Kit with a custom gulp process leveraging polymer-build, the library powering Polymer CLI.

Setup

Prerequisites

First, install Polymer CLI and generator-polymer-init-uniflow-polymer-starter-kit using npm (we assume you have pre-installed node.js).

npm install -g polymer-cli
npm install -g generator-polymer-init-uniflow-polymer-starter-kit
Initialize project from template

Generate your new project using polymer init:

mkdir my-app
cd my-app
polymer init uniflow-polymer-starter-kit

Start the development server

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

polymer serve --open

Build

This command performs HTML, CSS, and JS minification on the application dependencies, and generates a service-worker.js file with code to pre-cache the dependencies based on the entrypoint and fragments specified in polymer.json. The minified files are output to the build/unbundled folder, and are suitable for serving from a HTTP/2+Push compatible server.

In addition the command also creates a fallback build/bundled folder, generated using fragment bundling, suitable for serving from non H2/push-compatible servers or to clients that do not support H2/Push.

polymer build

Preview the build

This command serves the minified version of the app at http://localhost:8080 in an unbundled state, as it would be served by a push-compatible server:

polymer serve build/unbundled

This command serves the minified version of the app at http://localhost:8080 generated using fragment bundling:

polymer serve build/bundled

Run tests

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

polymer test

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 bundled build.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT License

Readme

Keywords

Package Sidebar

Install

npm i generator-polymer-init-uniflow-polymer-starter-kit

Weekly Downloads

1

Version

2.0.4

License

BSD-3-Clause

Last publish

Collaborators

  • lostinbrittany