{"id":26663171,"url":"https://github.com/startpolymer/generator-startpolymer","last_synced_at":"2025-03-25T14:20:12.778Z","repository":{"id":57149220,"uuid":"47450910","full_name":"StartPolymer/generator-startpolymer","owner":"StartPolymer","description":"Yeoman generator for Polymer projects","archived":false,"fork":false,"pushed_at":"2015-12-06T03:24:52.000Z","size":751,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-06T17:06:52.275Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StartPolymer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-05T09:59:53.000Z","updated_at":"2019-05-24T12:38:00.000Z","dependencies_parsed_at":"2022-08-29T20:50:49.899Z","dependency_job_id":null,"html_url":"https://github.com/StartPolymer/generator-startpolymer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartPolymer%2Fgenerator-startpolymer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartPolymer%2Fgenerator-startpolymer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartPolymer%2Fgenerator-startpolymer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartPolymer%2Fgenerator-startpolymer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StartPolymer","download_url":"https://codeload.github.com/StartPolymer/generator-startpolymer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245476694,"owners_count":20621699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-25T14:20:12.067Z","updated_at":"2025-03-25T14:20:12.718Z","avatar_url":"https://github.com/StartPolymer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version](http://img.shields.io/npm/v/generator-startpolymer.svg?style=flat)](http://npmjs.org/generator-startpolymer)\n[![NPM downloads](http://img.shields.io/npm/dm/generator-startpolymer.svg?style=flat)](http://npmjs.org/generator-startpolymer)\n[![Build Status](http://img.shields.io/travis/yeoman/generator-polymer/master.svg?style=flat)](https://travis-ci.org/yeoman/generator-polymer)\n[![Dependency Status](http://img.shields.io/david/yeoman/generator-polymer.svg?style=flat)](https://david-dm.org/yeoman/generator-polymer)\n\n## Start Polymer Generator\n\n\u003cimg src=\"http://i.imgur.com/dsFChIk.png\"/\u003e\n\n\u003e Yeoman generator for Polymer projects\n\n\u003e Start Polymer Generator is keeping up to date with [Polymer Generator](https://github.com/yeoman/generator-polymer)\n\n## Introduction\n\n[Polymer](http://www.polymer-project.org) 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.\n\n`generator-startpolymer` provides Polymer scaffolding using [Yeoman](http://yeoman.io) (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.\n\n## Features\n\n* A Polymer app scaffold built with [Polymer Starter Kit Plus](https://github.com/StartPolymer/polymer-starter-kit-plus)\n* Sub-generator to create Polymer elements for your app\n* Quick deploy to GitHub pages\n* All the goodness of [seed-element-plus](https://github.com/StartPolymer/seed-element-plus) (docs \u0026 landing page for your element)\n* [web-component-tester](https://github.com/Polymer/web-component-tester) support\n\n## Issues\n\nThis generator clones [Polymer Starter Kit Plus](https://github.com/StartPolymer/polymer-starter-kit-plus) and [seed-element-plus](https://github.com/StartPolymer/seed-element-plus). 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.\n\n## Installation\n\n### Install required tools `yo`, `gulp` and `bower`\n\n```sh\nnpm install -g yo gulp bower\n```\n\n### Install the generator\n\n```sh\nnpm install -g generator-startpolymer\n```\n\n## Run\n\n### Make a new directory and cd into it\n\n```sh\nmkdir -p my-project \u0026\u0026 cd $_\n```\n\n### Scaffold a new Polymer project\n\n```sh\nyo startpolymer\n```\n\n## Generators\n\nAvailable generators:\n\n- [startpolymer (aka polymer:app)](#app)\n- [startpolymer:element](#element-alias-el)\n- [startpolymer:seed](#seed)\n- [startpolymer:gh](#gh)\n\n**Note: Generators are to be run from the root of your app**\n\n### App\nSets up a new Polymer app, generating all the boilerplate you need to get started.\n\nExample:\n\n```sh\nyo startpolymer\n```\n\n### Element (alias: El)\nGenerates a polymer element in `app/elements` and optionally appends an import to `app/elements/elements.html`.\n\nExample:\n```bash\nyo startpolymer:element my-element\n\n# or use the alias\n\nyo startpolymer:el my-element\n```\n\n**Note: You must pass in an element name, and the name must contain a dash \"-\"**\n\nOne 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:\n\n```bash\nyo startpolymer:el fancy-menu paper-button paper-checkbox\n```\n\n#### Options\n\n```\n--docs, include iron-component-page docs with your element and demo.html\n--path, override default directory structure, ex: --path foo/bar will put your element in app/elements/foo/bar\n```\n\n### Seed\nGenerates a reusable polymer element based on the [seed-element-plus workflow](https://github.com/StartPolymer/seed-element-plus). **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](#element-alias-el) generator.\n\nTo preview your new element you'll want to use the [polyserve](https://github.com/PolymerLabs/polyserve) tool.\n\nExample:\n```bash\nmkdir -p my-foo \u0026\u0026 cd $_\nyo startpolymer:seed my-foo\npolyserve\n```\n\n### Gh\nGenerates a Github pages branch for your [seed-element](#seed).\n\n**This requires that you have [SSH keys setup on GitHub](https://help.github.com/articles/generating-ssh-keys/)**.\n\n**Windows users will need to have [Git Bash](https://git-for-windows.github.io/) installed**\n\nIf your documentation or demo pages have dependencies declared as devDependencies in `bower.json`, they will be included in your GitHub pages branch.\n\nExample:\n```bash\ncd my-foo\nyo startpolymer:gh\n```\n\nIf, for some reason, you don't want the devDependencies, use the `--nodevdeps` option.\n\n## Testing\n\nThe project generated by `yo startpolymer` contains support for [web-component-tester](https://github.com/Polymer/web-component-tester). The following commands are included:\n\nRun local tests (in terminal):\n```bash\ngulp test:local\n```\n\nRun remote tests with [SauceLabs](https://saucelabs.com/):\n```bash\ngulp test:remote\n```\n\nSee the [web-component-tester readme](https://github.com/Polymer/web-component-tester#configuration) for configuration options.\n\n## Gotchas\n\n### The `elements.html` file\n\nThe `app` generator will produce an `elements.html` file where you can place your imports. This file will be [vulcanized](https://www.polymer-project.org/articles/concatenating-web-components.html) 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**.\n\n## Contribute\n\nSee the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)\n\nWhen submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.\n\n## License\n\n[BSD license](http://opensource.org/licenses/bsd-license.php)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartpolymer%2Fgenerator-startpolymer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstartpolymer%2Fgenerator-startpolymer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartpolymer%2Fgenerator-startpolymer/lists"}