<commit_before># AlloyUI

![AlloyUI Robo Suit](http://f.cl.ly/items/292d3K0l3j221n3m0V0D/Alloy-Robo-Suit.jpg)

AlloyUI is a framework built on top of [YUI3](http://yuilibrary.com) (JavaScript) that uses [Bootstrap](http://liferay.github.io/alloy-bootstrap/) (HTML/CSS) to provide a simple API for building high scalable applications.

* [Official Website](http://alloyui.com/)
* [Examples](http://alloyui.com/examples/)
* [Tutorials](http://alloyui.com/tutorials/)
* [API Docs](http://alloyui.com/api/)
* [Rosetta Stone](http://alloyui.com/rosetta-stone/)
* [Contributing](http://alloyui.com/contributing/)
* [About](http://alloyui.com/about/)

## Automated tasks

Provides a set of util tasks to work with [AlloyUI](http://github.com/liferay/alloy-ui) project.

> To change any default option from a task check [Gruntfile.js](https://github.com/liferay/alloy-ui/blob/master/Gruntfile.js).

### Setup

1. Install [NodeJS](https://github.com/bevry/community/wiki/Installing-Node), if you don't have it yet.

2. Install global dependencies:

    ```
[sudo] npm install -g grunt-cli shifter yogi yuidocjs
    ```

3. Install local dependencies:

    ```
npm install
    ```

4. Initialize dependencies:

    ```
grunt init
    ```

### Build

* Build YUI and AlloyUI:

    ```
grunt build
    ```

* Build only YUI:

    ```
grunt build:yui
    ```

* Build only AlloyUI:

    ```
grunt build:aui
    ```

* Build and import Bootstrap's CSS:

    ```
grunt bootstrap
    ```

### Watch

* Watch and build for any changes:

    ```
grunt watch
    ```

### Create

* Create a new module under `src/` folder:

    ```
grunt create
    ```

### Release

* Generate a release zip file:

    ```
grunt compress
    ```

* Build modules and generate a release zip file:

    ```
grunt release<commit_msg>Add readme for grunt all<commit_after># AlloyUI

![AlloyUI Robo Suit](http://f.cl.ly/items/292d3K0l3j221n3m0V0D/Alloy-Robo-Suit.jpg)

AlloyUI is a framework built on top of [YUI3](http://yuilibrary.com) (JavaScript) that uses [Bootstrap](http://liferay.github.io/alloy-bootstrap/) (HTML/CSS) to provide a simple API for building high scalable applications.

* [Official Website](http://alloyui.com/)
* [Examples](http://alloyui.com/examples/)
* [Tutorials](http://alloyui.com/tutorials/)
* [API Docs](http://alloyui.com/api/)
* [Rosetta Stone](http://alloyui.com/rosetta-stone/)
* [Contributing](http://alloyui.com/contributing/)
* [About](http://alloyui.com/about/)

## Automated tasks

Provides a set of util tasks to work with [AlloyUI](http://github.com/liferay/alloy-ui) project.

> To change any default option from a task check [Gruntfile.js](https://github.com/liferay/alloy-ui/blob/master/Gruntfile.js).

### Setup

1. Install [NodeJS](https://github.com/bevry/community/wiki/Installing-Node), if you don't have it yet.

2. Install global dependencies:

    ```
[sudo] npm install -g grunt-cli shifter yogi yuidocjs
    ```

3. Install local dependencies:

    ```
npm install
    ```

4. Initialize dependencies:

    ```
grunt init
    ```

### Build

* Build YUI and AlloyUI:

    ```
grunt build
    ```

* Build only YUI:

    ```
grunt build:yui
    ```

* Build only AlloyUI:

    ```
grunt build:aui
    ```

* Build and import Bootstrap's CSS:

    ```
grunt bootstrap
    ```

* Build AlloyUI and import Bootstrap's CSS:

    ```
grunt all
    ```

### Watch

* Watch and build for any changes:

    ```
grunt watch
    ```

### Create

* Create a new module under `src/` folder:

    ```
grunt create
    ```

### Release

* Generate a release zip file:

    ```
grunt compress
    ```

* Build modules and generate a release zip file:

    ```
grunt release
{'fraction_non_alphanumeric': 0.15600326708412743, 'fraction_numerical': 0.009256738361012797, 'mean_word_length': 3.3634204275534443, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2154275', 'n_tokens_mistral': 1331, 'n_tokens_neox': 1269, 'n_words': 323}