An open-source entry in TopGit's GitHub warehouse: yeoman/generator-polymer, 913 stars, JavaScript. Scaffold out a Polymer project
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
We encourage you to take a look at
Polymer CLI which contains many of the
same features as this generator and has a larger team supporting it. We plan to
deprecate and eventually remove this project from GitHub and direct all future
support toward Polymer CLI. The good news is it uses Yeoman under the hood so
I'll see you there!
Yeoman generator for Polymer projects
Introduction
Polymer is a library of polyfills and sugar which enable the use of Web Components in modern browsers. The project allows developers to build apps using the platform of tomorrow and inform the W3C of places where in-flight specifications can be further improved.
generator-polymer provides Polymer scaffolding using Yeoman (a scaffolding tool for the web), letting you easily create and customize Polymer (custom) elements via the command-line and import them using HTML Imports. This saves you time writing boilerplate code so you can start writing up the logic to your components straight away.
Features
A Polymer app scaffold built with Polymer Starter Kit
Sub-generator to create Polymer elements for your app
Quick deploy to GitHub pages
All the goodness of seed-element (docs & landing page for your element)
web-component-tester support
Issues
This generator clones Polymer Starter Kit and seed-element. If you're having issues with the template files generated for those projects, please raise them on those repos as they are the canonical source.
Installation
Install the generator
npm install -g generator-polymer
Make a new directory and cd into it
mkdir -p my-project && cd $_
Scaffold a new Polymer project:
yo polymer
Generators
Available generators:
polymer (aka polymer:app)
polymer:element
polymer:seed
polymer:gh
Note: Generators are to be run from the root of your app
App
Sets up a new Polymer app, generating all the boilerplate you need to get started.
Example:
yo polymer
Element (alias: El)
Generates a polymer element in app/elements and optionally appends an import to app/elements/elements.html.
Example:
yo polymer:element my-element
# or use the alias
yo polymer:el my-element
Note: You must pass in an element name, and the name must contain a dash "-"
One can also include element dependencies to be imported. For instance, if you're creating a fancy-menu element which needs to import paper-button and paper-checkbox as dependencies, you can generate the file like so:
yo polymer:el fancy-menu paper-button paper-checkbox
Options
--docs, include iron-component-page docs with your element and demo.html
--path, override default directory structure, ex: --path foo/bar will put your element in app/elements/foo/bar
Seed
Generates a reusable polymer element based on the seed-element workflow. This should only be used if you're creating a standalone element repo that you intend to share with others via bower. If you're just building a Polymer app, stick to the Element generator.
To preview your new element you'll want to use the polyserve tool.
Example:
mkdir -p my-foo && cd $_
yo polymer:seed my-foo
polyserve
Gh
Generates a Github pages branch for your seed-element.
This requires that you have SSH keys setup on GitHub.
Windows users will need to have Git Bash installed
If your documentation or demo pages have dependencies declared as devDependencies in bower.json, they will be included in your GitHub pages branch.
Example:
cd my-foo
yo polymer:gh
If, for some reason, you don't want the devDependencies, use the --nodevdeps option.
Github Enterprise
Github Enterprise instances require a custom hostname to be defined. Use the --hostname option.
Example:
cd my-foo
yo polymer:gh --hostname custom.host.com
Testing
The project generated by yo polymer contains support for web-component-tester. The following commands are included:
Run local tests (in terminal):
gulp test:local
Run remote tests with SauceLabs:
gulp test:remote
See the web-component-tester readme for configuration options.
Gotchas
The elements.html file
The app generator will produce an elements.html file where you can place your imports. This file will be vulcanized when you run the default gulp task. You'll want to make sure that elements.html is the only import in your index.html file, otherwise there's a good chance you'll accidentally load Polymer twice and break the app.
Contribute
See the contributing docs
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
How active is development on yeoman/generator-polymer?
The most recent commit recorded on yeoman/generator-polymer was 9.8 years ago, based on the GitHub push timestamp. The repository has 148 forks — one of the better signals of community interest.
How many stars does yeoman/generator-polymer have?
yeoman/generator-polymer has 913 GitHub stars — refresh the page for the live number, or check github.com/yeoman/generator-polymer. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is yeoman/generator-polymer open source?
TopGit's metadata for yeoman/generator-polymer does not record a license. Most public repositories on GitHub ARE open source, but the exact terms vary — verify by opening the LICENSE file directly.
What is yeoman/generator-polymer?
yeoman/generator-polymer (yeoman/generator-polymer) is a JavaScript project on GitHub. From the project's own README: Scaffold out a Polymer project
Where do I read more about yeoman/generator-polymer?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/yeoman/generator-polymer is the definitive source.
Read full README in the tab above.
Want a second opinion on generator-polymer?
Ask an AI that can read this page — one click and you get its take on generator-polymer.