A modern UI kit packed with 2 custom page templates
and 11 extra custom components built on top of Shards UI and Bootstrap (4.5.3).

Components Demo • Templates Demo • Documentation • Official Page

### 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

Hello, world!

``` ### 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)