sethdford / mui Goto Github PK

A lightweight HTML/CSS/JS framework for sites that follow Google's Material Design guidelines.

Use From the CDN:

<link href="//cdn.muicss.com/mui-0.0.8/css/mui.min.css" rel="stylesheet" type="text/css" />
<script src="//cdn.muicss.com/mui-0.0.8/js/mui.min.js"></script>

Install with Bower:

$ bower install mui

MUI is designed from the ground up to be fast, small and developer friendly. By design it only includes the basic components you need to build a site that follows Google's Material Design guidelines. Some of the key features of MUI are:

• Small footprint: mui.min.css - 5.6K, mui.min.js - 3.7K (gzipped)
• A responsive grid to make mobile-friendly sites
• No external dependencies
• CSS library that can be customized with your own colors
• JS library can be loaded asyncronously
• Email library for styling HTML emails

To get started using MUI, go to the MUI website to see examples and download boilerplate HTML.

MUI is tested and works in:

• IE10+
• Latest Stable: Firefox, Chrome, Safari
• iOS 6+

1. Install dependencies

• nodejs (http://nodejs.org/)
• npm (https://www.npmjs.org/)
• sass (http://sass-lang.com/)
• http-server (via npm)

1. Clone repository

   $ git clone [email protected]:muicss/mui.git
   $ cd mui

2. Install node dependencies using npm

   $ npm install

3. Build examples

   $ ./node_modules/.bin/gulp build-examples

   To view the examples you can use any static file server. To use the nodejs http-server module:

   $ npm install http-server
   $ ./node_modules/.bin/http-server -p 3000

   Then visit http://localhost:3000/examples

4. Watch changes and re-build

   $ ./node_modules/.bin/gulp watch

To run the unit tests from the command line, run 'mocha':

$ ./node_modules/.bin/mocha

To run the E2E tests first compile the unit test files into a version that runs in the browser:

$ ./node_modules/.bin/gulp build-e2e-tests

Then visit http://localhost:3000/e2e-tests

To create a production build of the app, run gulp build-dist:

$ ./node_modules/.bin/gulp build-dist

The build will be located in the dist directory:

dist/
├── css
│   ├── mui.css
│   └── mui.min.css
├── email
│   ├── mui-email-inline.css
|   └── mui-email-styletag.css
├── js
│   ├── mui.js
│   └── mui.min.js
├── react
│   ├── mui-react.js
│   └── mui-react.min.js
└── webcomponents
    ├── mui-webcomponents.js
    └── mui-webcomponents.min.js