cumulocity-hellowidget-plugin
*** Heads-up! Since version 2.X, this Cumulocity UI plugin boilerplate is written in ES6+. :tada: ***
A demo app for showcasing creation of a custom Cumulocity UI widget plugin.
Why?
Currently there is this snore-inducing JSDoc for the API to allow adding components (widgets), but it is inadequately practical to show "how-to" in details. So, let's slay the Jabberwocky! :hocho: :dragon_face:
Installation
-
Make sure you have Node.js ≥ v6.11.0 installed and npm from its website, or better even, use nvm.
-
Clone the repo, cd
to your project directory, and setup dependencies:
$ npm run install:clean
Usage
Check out the introduction to plugin development docs.
Quicky up and running
Oh well, I know that you guys are a bunch of lazy people. How to get this app deployed and see it running on my tenant, you ask? Be my guest:
$ npm run deploy
After a few more steps in interactive command line user interfaces, you should then be able to access the app on https://<your-tenant-url>/apps/hellowidgetapp
.
Unit testing
$ npm t
Note that you may need to supply different app context path other than hellowidgetapp
in npm scripts for test
(in package.json
) if you want to reuse this boilerplate.
Linting
$ npm run lint <targetFileOrDir>
Example:
$ npm run lint plugins
Or better yet, make your IDE automatically integrate the linting process based on the .rc file (.eslintrc.yaml
).
The rules quite strictly follow the Airbnb JavaScript Style Guide (ES6+ without React).
Author
Glenn Dwiyatcita (@dwiyatci)
License
MIT.
See LICENSE.txt.