Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liferay/alloy-ui
Repo Moved. AlloyUI is a framework built on top of YUI3 (JavaScript) that uses Bootstrap 3 (HTML/CSS) to provide a simple API for building high scalable applications
https://github.com/liferay/alloy-ui
Last synced: about 2 months ago
JSON representation
Repo Moved. AlloyUI is a framework built on top of YUI3 (JavaScript) that uses Bootstrap 3 (HTML/CSS) to provide a simple API for building high scalable applications
- Host: GitHub
- URL: https://github.com/liferay/alloy-ui
- Owner: liferay
- License: other
- Archived: true
- Created: 2011-06-20T19:53:47.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2021-11-04T21:42:49.000Z (about 3 years ago)
- Last Synced: 2024-09-22T16:25:53.364Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://github.com/liferay/liferay-frontend-projects/tree/master/third-party/projects/alloy-ui
- Size: 670 MB
- Stars: 1,548
- Watchers: 114
- Forks: 676
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
> :warning: This repo is now archived (ie. switched to read-only mode). Alloy UI is deprecated and but future critical patches will continue at [`liferay/liferay-frontend-projects` monorepo](https://github.com/liferay/liferay-frontend-projects/tree/master/third-party/projects/alloy-ui).
---
# AlloyUI
AlloyUI is a framework built on top of [YUI3](http://yuilibrary.com) (JavaScript) that uses [Bootstrap 3](http://getbootstrap.com/) (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/)
## Browser Support
As an user interface framework we do care about browser support. Most of our modules use all the power of HTML5, so for old browsers we provide fallbacks in Flash.
 |  |  |  | 
--- | --- | --- | --- | --- |
IE 8+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
## Automated tasks
We use [Gulp](http://gulpjs.com/), a task-runner in Node, to automate things.
```
gulp
```
To discover the most commonly used tasks, run:
```
gulp help
```
### Setup
1. Install NodeJS <= [v0.12.0](http://nodejs.org/dist/v0.12.0/), if you don't have it yet.
2. Install global dependencies:
```
[sudo] npm install -g gulp
```
3. Install local dependencies:
```
npm install
```
4. Initialize and fetch dependencies via Bower:
```
gulp init
```
5. Build AlloyUI & YUI3 using Shifter:
```
gulp build
```
### Development
Rebuild AUI components:
```
gulp build-aui
```
If run at the root level, it will build all AUI components.
If run within a component folder (ie. `cd src/aui-datatable`), it will only build that specific component.
Watch for changes and rebuild automatically:
```
gulp watch
```
## Discussion
* [Liferay Forums](http://www.liferay.com/community/forums/-/message_boards/category/8409523)
* [Google Groups](https://groups.google.com/forum/?fromgroups#!forum/alloyui)
* [Stack Overflow](http://stackoverflow.com/questions/tagged/alloy-ui)
## Structure
The basic structure of the project is given in the following way:
* `bower_components/` Contains all dependencies fetched via [Bower](http://bower.io/). However, this directory is unnecessary for versioning, so it is ignored ([.gitignore](https://github.com/liferay/alloy-ui/blob/master/.gitignore)).
* `build/` Contains AlloyUI and YUI generated files, once build task has been run. However, this directory is unnecessary for versioning, so it is ignored ([.gitignore](https://github.com/liferay/alloy-ui/blob/master/.gitignore)).
* `demos/` Contains basic examples of the AlloyUI modules.
* `src/` Contains the source code of the AlloyUI modules.
* `tasks/` Contains the source code of the [Gulp](http://gulpjs.com/) tasks.
* `.alloy.json` Specifies all dependencies and some configurations.
* `.editorconfig` Specifies the coding style for different editors/IDEs.
* `.jsbeautifyrc` Specifies the coding format rules for [JSBeautify](http://jsbeautifier.org/).
* `.jshintrc` Specifies the linting configurations for [JSHint](http://www.jshint.com/).
* `.yeti.json` Specifies the testing configurations for [Yeti](http://yeti.cx/).
* `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 Liferay's Frontend Infrastructure team and a bunch of awesome [contributors](https://github.com/liferay/alloy-ui/graphs/contributors).
[](https://github.com/liferay-frontend) |
--- |
[Liferay Frontend Infrastructure Team](https://github.com/liferay-frontend) |
## History
Discover all versions in the [Releases](https://github.com/liferay/alloy-ui/releases) page.
Each module (located under `src/`) contains a `HISTORY.md` file, check them for detailed changelog.
## License
[BSD-3-Clause License](https://github.com/liferay/alloy-ui/blob/master/LICENSE.md) (c) Liferay, Inc.