slush-element 0,0 travis-ci npm

Slush generator to create Custom Elements using Polymer, X-Tag or VanillaJS

3 years after MIT

Slush Generator
for Custom Elements

NPM version NPM downloads Build Status Dependency Status

Web Components + Slush

A Slush Generator that provides a functional boilerplate to easily create Custom Elements using Polymer, X-Tag or VanillaJS.

All templates are based in the boilerplates authored by the WebComponents.org team:

Install

Install this generator using NPM:

$ [sudo] npm install -g slush-element

Getting Started

There are two different generators available.

  • The first one used to scaffold out new individual elements:

    $ slush element
    [?] What do you want to use?
    [?] What's the name of your element?
    [?] Do you want to include lifecycle callbacks?

    Which will generate the following file::

    .
    └── my-element.html
  • The second one is used to scaffold an entire project:

    $ slush element:repo
    [?] What do you want to use?
    [?] What's the GitHub repository?
    [?] What's your GitHub username?
    [?] What's the name of your element?
    [?] How would you describe the element?
    [?] Do you want to include lifecycle callbacks?
    [?] Do you want to include some useful Gulp tasks?

    Which will generate the following project structure with npm and bower dependencies installed:

    .
    ├── .editorconfig
    ├── .gitignore
    ├── bower.json
    ├── bower_components/
    ├── package.json
    ├── index.html
    ├── node_modules/
    ├── gulpfile.js
    ├── src/my-element.html
    └── README.md

Note: files will be generated in the current directory, so be sure to change to a new directory before running those commands if you don't want to overwrite existing files.

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

Team

This project is maintained by these people and a bunch of awesome contributors.

Beto Muniz Zeno Rocha
Beto Muniz Zeno Rocha

License

MIT License © WebComponents.org

Related Repositories

angular2-education

angular2-education

A list of helpful material to develop using Angular ...

webcomponents-the-right-way

webcomponents-the-right-way

This is a guide intended to introduce to Web Components. Everyone can contribute ...

awesome-webcomponents

awesome-webcomponents

A curated list of awesome Web Components tools, articles and resources. ...

codecolorer

codecolorer

WordPress plugin which allows you to insert code snippets into the post with nic ...

angular2-education

angular2-education

A curated list of helpful material to get started with education on Angular 2 ...


Top Contributors

obetomuniz mateusortiz sindresorhus zenorocha

Dependencies

package version
gulp 3.9.1
gulp-conflict ^0.4.0
gulp-install 0.6.0
gulp-rename 1.2.2
gulp-template 4.0.0
inquirer 1.2.1
mocha 3.1.0
underscore.string 3.3.4
dev mock-gulp-dest ^0.1.1
mocha *

Releases

-   v1.0.0 zip tar