This repository has been archived by the owner. It is now read-only.
UI for gitcheese.api
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cloudformation
images
src
.eslintrc.json
.gitignore
.travis.yml
README.md
bower.json
index.html
manifest.json
package.json
polymer.json
service-worker.js
sw-precache-config.js

README.md

Polymer App Toolbox - Starter Kit

Build Status

This template is a starting point for building apps using a drawer-based layout. The layout is provided by app-layout elements.

This template, along with the polymer-cli toolchain, also demonstrates use of the "PRPL pattern" This pattern allows fast first delivery and interaction with the content at the initial route requested by the user, along with fast subsequent navigation by pre-caching the remaining components required by the app and progressively loading them on-demand as the user navigates through the app.

The PRPL pattern, in a nutshell:

  • Push components required for the initial route
  • Render initial route ASAP
  • Pre-cache components for remaining routes
  • Lazy-load and progressively upgrade next routes on-demand

Setup

Prerequisites

First, install Polymer CLI using npm (we assume you have pre-installed node.js).

npm install -g polymer-cli

And install the dependencies:

npm install && bower install

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

The included gulpfile.js relies on the polymer-build library, the same library that powers Polymer CLI. Out of the box it will clean the build directory, and provide image minification. Follow the comments in the gulpfile.js to add additional steps like JS transpilers or CSS preprocessors.

gulpfile.js also generates a service-worker.js file with code to pre-cache the dependencies based on the entrypoint and fragments specified in polymer.json.

npm run build

Preview the build

This command serves the minified version of the app at http://localhost:8080:

polymer serve build/

Run tests

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

polymer test

Adding a new build step

The gulpfile.js already contains an example build step that demonstrates how to run image minification across your source files. For more examples, refer to the section in the polymer-build README on extracting inline sources.

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.