AlloyUI

AlloyUI is a framework built on top of YUI3 (JavaScript) that uses Bootstrap (HTML/CSS) to provide a simple API for building high scalable applications.

• Official Website
• Examples
• Tutorials
• API Docs
• Rosetta Stone
• Contributing
• About

Automated tasks

Provides a set of util tasks to work with AlloyUI project.

To change any default option from a task check Gruntfile.js.

Setup

1. Install NodeJS, 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 ```

Test

• Run unit tests:

grunt test ```

API Docs

• Build docs locally:

grunt api-build ```

• Build docs locally and deploy it to alloyui.com:

grunt api-deploy ```

• Run docs locally and watch for any changes:

grunt api-watch ```

Discussion

• Liferay Forums
• Google Groups
• Stack Overflow

Structure

The basic structure of the project is given in the following way:

• build/ Contains AlloyUI and YUI generated files, once Yogi Alloy's build task has been run. However, this directory is unnecessary for versioning, so it is ignored (.gitignore).
• demos/ Contains basic examples of the AlloyUI modules.
• src/ Contains the source code of the AlloyUI modules.
• .alloy.json Specifies all dependencies and some configurations.
• .editorconfig Specifies the coding style for different editors/IDEs.
• LICENSE.md Defines the license agreement for AlloyUI.
• README.md Explains the AlloyUI project.
• package.json Lists all NodeJS dependencies.

Team

AlloyUI is maintained by these people and a bunch of awesome contributors.

| | | | --- | --- | --- | --- | --- | --- | --- Eduardo Lundgren | Nate Cavanaugh | Bruno Basto | Iliyan Peychev | Zeno Rocha

License

BSB license