Skip to content

miguelramosfdz/mui

 
 

Repository files navigation

MUI HTML/CSS/JS Framework

Build Status Dependency Status devDependency Status

Development Dependencies

Development Quickstart

  1. Clone repository

    $ git clone git@github.com:amorey/mui.git
    $ cd mui
  2. Install node dependencies using npm

    $ npm install
  3. Install bower dependencies

    $ bower install
  4. 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

  5. Watch changes and re-build

    $ ./node_modules/.bin/gulp watch

Run tests

Unit tests

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

$ ./node_modules/.bin/mocha

E2E tests

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

Create a production build

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

About

MUI is a lightweight HTML, CSS and JS framework for sites that follow Google's Material Design guidelines

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 94.5%
  • CSS 3.6%
  • HTML 1.9%