@therunninghub/joy-ui
Version:
A free, modern and lightweight Bootstrap 4 UI toolkit for web makers.
110 lines (82 loc) • 4.15 kB
Markdown
<p align="center">
<img src="logo.jpg" width="250" />
</p>
<p align="center">
A modern UI kit packed with 2 custom page templates <br/>and 11 extra custom components built on top of Shards UI and Bootstrap (4.5.3).
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@therunninghub/joy-ui">
<img src="https://img.shields.io/npm/v/@therunninghub/joy-ui.svg" alt="`npm` version"/>
</a>
<a href="https://www.npmjs.com/package/@therunninghub/joy-ui">
<img src="https://img.shields.io/npm/dm/@therunninghub/joy-ui.svg" alt="`npm` downloads"/>
</a>
<a href="#">
<img src="https://img.shields.io/badge/Size-14.05_kb_min/gz-brightgreen.svg" />
</a>
<a href="#">
<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" />
</a>
<a href="https://twitter.com/intent/tweet?url=https://github.com/therunninghub/joy-ui&text=I%20love%20the%20free%20Joy%20UI%20kit%20based%20on%20%23Bootstrap%20by%20%40The%20Running%20Hub%20%23ui%20%23kit%20%23freebie%20">
<img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" />
</a>
<br/>
<a href="https://david-dm.org/therunninghub/joy-ui">
<img src="https://img.shields.io/david/therunninghub/joy-ui.svg" alt="Dependencies"/>
</a>
<a href="https://david-dm.org/therunninghub/joy-ui?type=dev">
<img src="https://img.shields.io/david/dev/therunninghub/joy-ui.svg" alt="DevDependencies"/>
</a>
</p>
<p align="center">
<a href="https://opensource.therunninghub.net/demo/joy-ui/">Components Demo</a> •
<a href="https://opensource.therunninghub.net/demo/joy-ui/#extras">Templates Demo</a> •
<a href="https://github.com/therunninghub/joy-ui/wiki">Documentation</a> •
<a href="https://opensource.therunninghub.net/demo/joy-ui/">Official Page</a>
</p>
### Getting Started
Currently there are only three ways of downloading Joy UI:
* [Official Website](https://github.com/therunninghub/joy-ui)
* [Release Package](https://github.com/therunninghub/joy-ui/releases)
* [`npm`](https://www.npmjs.com/package/@therunninghub/joy-ui)
The distributed Joy UI assets are also available via CDN through [unpkg](https://unpkg.com/@therunninghub/joy-ui@latest/) and [jsDelivr](https://cdn.jsdelivr.net/npm/@therunninghub/joy-ui@latest/).
To install with `npm`:
```bash
npm install --save @therunninghub/joy-ui bootstrap
```
To install with `yarn`:
```bash
yarn add @therunninghub/joy-ui bootstrap
```
### Dependencies
The only hard dependency is Bootstrap 4.5.3 which needs to be included in your HTML document before Joy UI.
### 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 Joy UI's 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://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
<link rel="stylesheet" href="https://unpkg.com/@therunninghub/joy-ui@latest/dist/css/joy.min.css">
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>
```
### Built using
* [Material Icons](http://material.io/icons)
* [FontAwesome Icons](http://fontawesome.io)
### Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
### Feedback
Building better products is something we are trying to get really good at. We would love to hear more about how you plan on using Joy UI and what features you consider important in similar products.
### 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.
### Changelog
[View notable changes.](CHANGELOG.md)