catsys-cli
v1.1.3
Published
CLI Tool for LitElement
Downloads
3
Maintainers
Readme
Catsys CLI
A CLI useful for Lit Elements
Getting Started
catsys component:create <component-tag> [--styles, -s] <style>
: Creates a WebComponent based in lit-element- Supports stylus, sass and less
catsys component:serve
: Deploys in developing mode your component.catsys component:test
: Runs the unit tests in the componentcatsys app:create <name> [--basic, -b]
: Creates a PWA boilerplate vanillacatsys app:create <name> [--redux, -r]
: Creates a PWA boilerplate with redux integration for navigates and layer communication for pages.catsys app:serve [--static, -s]
: Deploys static files ES5 compatibility highcatsys app:serve [--develop, -d]
: Deploys the current code in srccatsys app:component <component-name>
: Creates a WebComponent based in lit-element light for appcatsys app:page <page-name>
: Creates a page with redux connection. Also, provides a new property_[page_name]State
in your app shell ready to use.
app:serve
is develop mode [dafault]
Prerequisites
You need to have installed > NodeJS 8.x and NPM, Yarn is optional. Also requires install polymer
npm install --global polymer-cli
Installing
npm install --global catsys-cli
npm i -g catsys-cli
For local developing: Only clone the repository and install the dependencies.
npm i
And that's all, you can use the repository in your local environment
npm link
Maybe you require generate a symbolic link, you can the command before for that.
Built With ❤
- NodeJS - The technology used
- Gulp - Task Management
- BrowserSync - Used to refresh the browser
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Alfonso Ríos - Initial work - Alfonso
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc