slush-element
v1.0.0
Published
A slush generator of custom elements with Polymer, X-Tag or VannilaJS based in generator-element
Downloads
13
Maintainers
Readme
Slush Generator for Custom Elements
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
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Team
This project is maintained by these people and a bunch of awesome contributors.
| --- | --- | --- | --- | --- Beto Muniz | Zeno Rocha
License
MIT License © WebComponents.org