generator-appsngen-web-widget

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-appsngen-web-widget from npm, run:

$ npm install -g generator-appsngen-web-widget

Finally, initiate the generator:

$ yo appsngen-web-widget

Also you can pass optinal path argument to generate widget at specified path.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Widget Structure

After widget template generated it has following structure:

|-- bower_components |-- dist |-- documentation |-- node_modules |-- src |    |-- styles |    |-- fonts |    |-- images |    |-- js |    |index.html |    |application.xml |-- tests |    |-- mocks |    |-- specs |bower.json |Gruntfile.js |package.json

• /bower_components - automatically generated folder with widget build or test run results output.
• /dist - automatically generated folder with widget build or test run results output.
• /documentation - folder for placing documentation about widget.
• /node_modules - node modules used for widget building.
• /src - widget sources.
• /src/application.xml - config with widget metadata.
• /src/index.html - widget main page.
• /tests - widget tests using Jasmine.
• /bower.json - widget dependencies. These dependencies are used by widget.
• /Gruntfile.js - widget build automation file. See Grunt for more details.
• /package.json - dependencies required by Grunt in order to build a widget or run its tests.

Running Grunt

Build development version of widget, without files minification:

$ grunt dev

Build development version of widget automatically after any change:

$ grunt dev-watch

Build production version of widget, with files minification:

$ grunt 

Run js and less/css linters:

$ grunt lint

Run Jasmine tests with code coverage:

$ grunt test

After grunt command run, output zip archive will be created at thr dist folder. This archive can be uploaded to Sandbox.

License

MIT