| 1 | # Marble
|
| 2 |
|
| 3 | > A set of UI components behind [Electric](https://electricjs.com/) and [WeDeploy](https://wedeploy.com/).
|
| 4 | >
|
| 5 | > It is built with HTML, Sass, and Javascript with [Bootstrap](http://getbootstrap.com/) as a foundation.
|
| 6 |
|
| 7 | ## Install
|
| 8 |
|
| 9 | You can get it on npm.
|
| 10 |
|
| 11 | ```
|
| 12 | npm install marble --save
|
| 13 | ```
|
| 14 |
|
| 15 | Or if you're not into package management, just [download a ZIP](https://github.com/wedeploy/marble/archive/master.zip) file.
|
| 16 |
|
| 17 | ## Development
|
| 18 |
|
| 19 | 1. Install local dependencies:
|
| 20 |
|
| 21 | ```sh
|
| 22 | npm install
|
| 23 | ```
|
| 24 |
|
| 25 | 2. Compile fonts and styles:
|
| 26 |
|
| 27 | ```sh
|
| 28 | npm run build
|
| 29 | ```
|
| 30 |
|
| 31 | 3. Watch for file changes:
|
| 32 |
|
| 33 | ```sh
|
| 34 | npm run dev
|
| 35 | ```
|
| 36 |
|
| 37 | ## License
|
| 38 |
|
| 39 | [BSD License](https://github.com/wedeploy/marble/blob/master/LICENSE.md) © Liferay, Inc.
|
| 40 | |
| \ | No newline at end of file |