@cubefuse/qube
Version:
The Cubefuse Design System.
122 lines (87 loc) • 4.56 kB
Markdown
<div align="center">
<img src="logo.jpg" width="250" />
</div>
<p align="center">
Built according to Cubefuse branding on top of Bootstrap (4.1.3), Qube provides a solid foundation for web projects, while being lightweight with a stylesheet weighing just 13.5kb.
</p>
<br />
<p align="center">
<a href="https://www.npmjs.com/package/@cubefuse/qube">
<img src="https://img.shields.io/npm/v/@cubefuse/qube.svg" alt="`npm` version"/>
</a>
<a href="#">
<img src="https://img.shields.io/badge/Size-14.3_kb_min/gz-brightgreen.svg" />
</a>
<a href="#">
<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" />
</a>
</p>
<br />
### Getting Started
Qube can be installed with `npm` or `yarn`
```bash
npm install --save @cubefuse/qube bootstrap
yarn add @cubefuse/qube bootstrap
```
The distributed Qube assets are also available via CDN through [unpkg](https://unpkg.com/@cubefuse/qube@latest/) and [jsDelivr](https://cdn.jsdelivr.net/npm/@cubefuse/qube@latest/).
<br />
### Dependencies
The only hard dependency is Bootstrap 4 (final) which needs to be included in your HTML document before Qube. Datepickers and slider controls also require the Qube JavaScript dependency.
<br />
### Quick Start
If you're using a bundler like `webpack`, you should skip to [Usage with Bundlers](#usage-with-bundlers).
In order to take advantage of both Bootstrap and Qube' features you may want to use the following starter template that includes all dependencies.
```html
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS Dependencies -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://unpkg.com/@cubefuse/qube@latest/dist/css/qube.min.css">
</head>
<body>
<h1>Hello, world!</h1>
<!-- Optional JavaScript -->
<!-- JavaScript Dependencies: jQuery, Popper.js, Bootstrap JS, Qube JS -->
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
<script src="https://unpkg.com/@cubefuse/qube@latest/dist/js/qube.min.js"></script>
</body>
</html>
```
<br />
### Usage with Bundlers
If you're using a bundler like [`webpack`](https://webpack.js.org) (with [`style-loader`](https://github.com/webpack-contrib/style-loader)/[`css-loader`](https://github.com/webpack-contrib/css-loader)) or [`parcel`](https://parceljs.org), you can [install `qube` with `npm`](#getting-started) and import it:
```javascript
// app.js
import 'bootstrap/dist/css/bootstrap.min.css';
import '@cubefuse/qube/dist/css/qube.min.css';
// Optional JavaScript
// JavaScript Dependencies: jQuery, Popper.js, Bootstrap JS, Qube JS
// Install them with `npm` as well
import 'jquery/dist/jquery.slim.min';
import 'popper.js/dist/umd/popper.min';
import 'bootstrap/dist/js/bootstrap.min';
import '@cubefuse/qube/dist/js/qube.min';
```
<br/>
### Built using
* [Shards by DesignRevision (MIT License)](https://designrevision.com/downloads/shards/)
* [Bootstrap by Bootstrap team (MIT License)](https://getbootstrap.com)
* [Bootstrap Datepicker by Stefan Petre and Andrew Rowls (Apache 2.0)](https://github.com/uxsolutions/bootstrap-datepicker)
* [noUiSlider by Léon Gersen (WTFPL License)](https://refreshless.com/nouislider/download/)
* [Material Icons](http://material.io/icons)
* [FontAwesome Icons](http://fontawesome.io)
<br />
### Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
<br />
### Acknowledgments
While building this project we used various free resources built and made
available by some wonderful people around the world. See the [ATTRIB.md](ATTRIB.md) file for details.
<br />
### Changelog
[View notable changes.](CHANGELOG.md)