Generator-commonsolutionaddon NPM

Common Solution Addon Generator

Purpose

This tool is intended as an helper to create from scratch a startup project for a Common Solution Addon. It's an NPM package, specifically we're talking about a Yeoman Custom Generator.

First-time setup

In order to install this Yeoman Generator, you have to open your terminal and then type the following instructions:

```
npm install -g yo
```

npm install -g generator-commonsolutionaddon

How to use

Once you've installed Yeoman and the "Common Solution Addon" generator, with your terminal opened, go through the desired installation directory (we reccomend the "Addon.Sample" root directory) and type

    yo commonsolutionaddon

Now you should see the program prompting asking you a few questions:

Author name:\ Presumably, it's your Unit and Pillar name. "Deltatre" will automatically being included as prefix
Copyright year:
Your addon name (in PascalCase):\ Please, give it a meaningful name in PascalCase (camelcase with also the first letter uppercase)
Your addon description:\ "WhiteLabel" and category name will be automatically added as prefix
Which category will it be?\ The category in which you want to classify your Addon, if no one of them fit in what are you looking for, please select "Another" at the end of the showed list.
Please enter your custom category\ (Showed only when "Another" is selected in the previous question)\ Here you can input your custom category: please remember to write it Camelcase.
Insert install directory:\ Your installation directory; by default is the one in which you're executing the Yeoman script. If you are in the Addon.Sample solution root, it will automatically install the addon accordingly with the selected category.