amazeui: A JavaScript repository from lmafwo

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

功能简介

为移动而生

Amaze UI 遵循 Mobile first 理念，从小屏逐步扩展到大屏，最终实现跨屏适配，适应移动互联潮流。

组件丰富，模块化

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

本地化支持

相比国外的前端框架，Amaze UI 专注解决中文排版优化问题，根据操作系统调整字体，实现最佳中文排版效果；针对国内主流浏览器及 App 内置浏览器提供更好的兼容性支持，为你节省大量兼容性调试时间。

轻量级，高性能

Amaze UI 非常注重性能，基于轻量的 Zepto.js 开发，并使用 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      # 第三方文件
|   |-- amazeui.partials.js
|   |-- handlebars
|   |-- json.format.js
|   |-- seajs
|   `-- zepto
`-- 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 1.0 in JSBin

需求提交

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

贡献代码

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

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

我们希望用户参与的项目

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

开发文档

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

参考、使用的项目

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

lmafwo/amazeui