README.md

grunt-init-wirecloud-operator

Create a WireCloud operator with grunt-init, including Jasmine unit tests.

Installation

If you haven't already done so, install grunt-init.

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git to clone this template into that directory, as follows:

git clone https://github.com/Wirecloud/grunt-init-wirecloud-operator.git ~/.grunt-init/wirecloud-operator

(Windows users, see the documentation for the correct destination directory path)

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

grunt-init wirecloud-operator

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

This template creates an operator project with a structure similar to the following one:

.
├── bower.json
├── Gruntfile.js
├── LICENSE-MIT
├── package.json
├── README.md
└── src
    ├── config.xml
    ├── css
    │   └── styles.css
    ├── DESCRIPTION.md
    ├── doc
    │   ├── changelog.md
    │   └── index.md
    ├── js
    │   └── main.js
    └── test
        ├── fixtures
        │   └── index.html
        ├── helpers
        │   └── empty.js
        └── js
            └── MyAwesomeOperatorSpec.js

8 directories, 16 files