Scaffold out a King of App Module

Usage no npm install needed!

<script type="module">
  import generatorKoappModule from '';




Scaffold out a King of App Module


First, install Yeoman and generator-koapp-module using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g gulp
npm install -g generator-koapp-module

Generate your new module:

yo koapp-module moduleName

Optionally, you can include the following flags:

  • -u authorName
  • -w authorHomepage
  • -s spanishDescription
  • -e englishDescription
  • -p price
  • -l license
  • -c categories separated by comma

Then start your new module:

cd {Project-name} && gulp

Automated Tasks (Gulp)

Main Tasks

  • gulp It runs watch-config, watch-bower, watch-documentation
  • gulp distribution It runs dist-zip

All Tasks

  • gulp lint Linter for your code.
  • gulp e2e It runs integration test with Protractor.
  • gulp jsdoc It creates JsDoc documentation.
  • gulp dist-zip It generates a compression file ready to upload
  • gulp watch-documentation It is monitoring for changes in documentation, also it will update config.json
  • gulp watch-bower It's monitoring for changes in bower.json.
  • gulp watch-config It's monitoring for changes in config.json, also it will update a../../app/core/structure.json


Please open an issue with your suggestion/question.

If you want to improve the code, please follow these steps and submit a pull request.

  • Download
git clone && cd generator-koapp-module
  • Install all dependencies
npm install
  • Added to local NPM
npm link
  • Execute it
  • Test your changes ;-)
npm test


MIT © King of App