alfredzh / graceful-web-ui

A Graceful And Cross Browser Web UI Framework

A graceful and cross browser web ui framework

supported browser: ie6+ firefox4+ safari chrome and so on.

project homepage: http://www.grace.guoyao.me/

including source code and demo for graceful-web-ui by guoyao.

Graceful-web-ui v0.1.0alpha

Graceful-web-ui is a graceful, cross browser, and powerful front-end framework for faster and easier web development, created and maintained by Guoyao Wu.

To get started, check out http://grace.guoyao.me!

Quick start

Two quick start options are available:

• Download the latest devlopment version.
• Clone the repo: git clone git://github.com/guoyao/graceful-web-ui.git.

Read the Getting Started page for information on the framework contents, templates and examples, and more.

Bugs and feature requests

Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.

Documentation

Please check Getting Started page for information, no standard documentation now.

Compiling CSS and JavaScript

Graceful-web-ui uses Grunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.

Install Grunt

From the command line:

1. Install grunt-cli globally with npm install -g grunt-cli.
2. Install the necessary local dependencies via npm install

When completed, you'll be able to run the various Grunt commands provided from the command line.

Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Available Grunt commands

Build - grunt

Run grunt to compile the CSS and JavaScript into /dist. Requires recess and uglify-js., and compile the resources for demo.

Only compile CSS and JavaScript - grunt dist

grunt dist creates the /dist directory with compiled files. Requires recess and uglify-js.

Run local server for demo - grunt server

grunt server will start a local server for demo

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Contributing

Please read through our guidelines for contributing to Graceful-web-ui. Included are directions for opening issues, coding standards, and notes on development.

More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests.

Community

Keep track of development and community news.

• Follow @wuguoyao on Twitter.
• Read and subscribe to the The Official Blog.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Graceful-web-ui will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

• Breaking backward compatibility bumps the major (and resets the minor and patch)
• New additions without breaking backward compatibility bumps the minor (and resets the patch)
• Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.

Authors

Guoyao Wu

• https://twitter.com/wuguoyao
• http://github.com/guoyao
• http://guoyao.me

Major Contributors

Alfredzh

• http://github.com/alfredzh

Redstarter

• http://github.com/redstarter

Copyright and license

Copyright 2013 Guoyao Wu under the Apache 2.0 license.