This is the generator for Reach projects

Usage no npm install needed!

<script type="module">
  import generatorPolymerInitReachStarterKit from '';


reach-starter-kit generator

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



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

npm install -g polymer-cli
npm install -g generator-polymer-init-reach-starter-kit
npm install -g bower
npm install -g yo
Initialize project from template

Generate your new project using polymer init:

mkdir my-app
cd my-app
polymer init reach-starter-kit
Add a page

Generate a page of the project using yo polymer-init-reach-starter-kit:page:

# inside my-app
Add a custom component

Generate a custom component of the project using yo polymer-init-reach-starter-kit:element:

# inside my-app
Run watchers while development

Run gulp watchers to inject SASS files or edit the shell app's pages and routing:

npm run gulp watch-all

Start the development server

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

polymer serve --open


Rather than rely on the usual polymer build command, this project gives you an "escape hatch" so you can include additional steps in your build process.

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.

npm run gulp

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 build step

The gulpfile 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 have bundles created in the fallback bundled build).


The Polymer project uses a BSD-like license available here

Steps in building

Steps I did to build this (based on how to build a CLI generator and how to create a yeoman generator) :

  1. Install yeoman generator

     npm install -g yo generator-generator
  2. Created a folder

     mkdir generator-polymer-init-reach-starter-kit
  3. Run Yo and pick Generator then set the necessary options in there

  4. Set the necessary prompts for getting variables at generators/app/index.js