Amaze UI 是基于社区开源项目构建的一个跨屏前端框架。 README in English

功能简介

移动优先

以移动优先（Mobile first）为理念，从小屏逐步扩展到大屏，最终实现所有屏幕适配，适应移动互联潮流。

组件丰富，模块化

Amaze UI 含近 20 个 CSS 组件、10 个 JS 组件，更有 17 款包含近 60 个主题的 Web 组件，可快速构建界面出色、体验优秀的跨屏页面，大幅提升开发效率。

本地化支持

相比国外框架，Amaze UI 关注中文排版，根据用户代理调整字体，实现更好的中文排版效果；兼顾国内主流浏览器及 App 内置浏览器兼容支持。

轻量级，高性能

Amaze UI 面向 HTML5 开发，使用 CSS3 来做动画交互，平滑、高效，更适合移动设备，让 Web 应用更快速载入。

下载及使用

用户可以从 Amaze UI 官网 下载打包好的模板。

所有文档存放在 docs/ 目录下，为方便查看演示效果，建议通过 Amaze UI 官网查看文档。

开发及构建

用户可以在 Amaze UI 的基础上进行二次开发。

目录结构

amazeui
|-- HISTORY.md
|-- LICENSE
|-- README.md
|-- package.json
|-- dist        # 构建目录
|-- docs        # 文档
|-- fonts       # Icon font，目前使用了 http://staticfile.org/
|-- gulpfile.js # 构建配置文件
|-- js          # JS 文件
|-- less        # LESS 文件
|-- tools       # 相关工具
|-- vendor
`-- widget      # Web 组件

构建工具

Amaze UI 使用 gulp.js 构建项目。

首先全局安装 Gulp：

npm install -g gulp

Clone 项目文件:

git clone https://github.com/allmobilize/amazeui.git

然后进入目录安装依赖：

npm install

接下来，执行 gulp：

gulp

Bug 反馈及需求提交

Bug 反馈

欢迎给 Amaze UI 提交 Bug。

为了能最准确的传达所描述的问题， 建议你在反馈时附上演示，方便我们理解。

下面的几个链接是我们在几个在线调试工具上建的页面， 已经引入了 Amaze UI 样式和脚本，你可以【Fork】一份，把要有问题的场景粘在里面，反馈给我们。

• Debug Amaze UI 2.x in JSBin
• Debug Amaze UI 1.x in JSBin

需求提交

用户可以通过 Issue 系统或者官网留言提交需求，符合 Amaze UI 理念的需求我们都会考虑。

贡献代码

欢迎大家加入捉虫队伍，同时大家也可以分享自己的开发的 Web 组件。Fork 本项目，然后提交 Pull Request 即可。

如果你没有相关经验，建议先阅读下面的文章：

• Contributing to Open Source on GitHub
• The Beginner’s Guide to Contributing to Open Source Projects
• How to Start Contributing to Open Source

我们希望用户参与的项目

• 把使用 Amaze UI 的项目提交给我们，能获得一定的展示量，同时能给其他用户提供参考；
• SCSS 等其他 CSS 扩展语言的支持：通过编写自动转换脚本实现，人工迁移同步更新成本太高；
• 使用 Amaze UI 开发制作模板；
• Angular.js、Ember.js、Meteor 等框架的支持；
• 基于 Amaze UI 样式开发 JavaScript 插件，可以把 Bootstrap 的插件移植到 Amaze UI；
• 兼容性测试，我们的测试只能覆盖有限，需要更多用户参与，包括浏览器、WebView 等不同的用户代理；
• ...

开发文档

开发文档存放在 docs/styleguide 目录下，也可以通过 Amaze UI 官网查看：

• Amaze UI HTML/CSS 编写规范
• Amaze UI JavaScript 编写规范
• Amaze UI Web 组件开发规范

参考、使用的项目

• Zepto.js (MIT License)
• Sea.js (MIT License)
• Handlebars.js (MIT License)
• normalize.css (MIT License)
• FontAwesome (CC BY 3.0 License)
• Bootstrap (MIT License)
• UIkit (MIT License)
• Foundation (MIT License)
• Framework7 (MIT License)
• Alice (MIT License)
• Arale (MIT License)
• Pure (BSD License)
• Semantic UI (MIT License)
• FastClick (MIT License)
• screenfull.js (MIT License)
• FlexSlider (GPL 2.0)
• Hammer.js (MIT License)
• Flat UI (CC BY 3.0 and MIT License)
• store.js (MIT License)
• bootstrap-datepicker.js (Apache License 2.0)
• iScroll (MIT License)

可能会有部分项目遗漏，我们会不断整理更新。

Developed with Open Source Licensed WebStorm