README.md

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

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.
• .shifter.json Specifies additional configuration used in building AlloyUI.
• LICENSE.md Defines the license agreement for AlloyUI.
• README.md Explains the AlloyUI project.
• package.json Lists all NodeJS dependencies.

Build

Dependencies

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 ```

Grunt

Provides a set of util tasks to work with AlloyUI project. For any configuration, check Gruntfile.js.

• Clone or update dependencies:

grunt init ```

• Build YUI and AlloyUI:

grunt build ```

• Build only YUI:

grunt build:yui ```

• Build only AlloyUI:

grunt build:aui ```

• Create a new module under src/ folder:

grunt create ```

• Generate a zip file from build/ folder:

grunt release ```

• Run unit tests using Yogi:

grunt test ```

• Build and watch for any changes:

grunt watch ```

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