Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 4.74 KB

README.md

File metadata and controls

90 lines (66 loc) · 4.74 KB

Price Size License

Shards is a free and modern UI kit that comes packed with 2 pre-built pages and 11 extra custom components that you can use to kick off your next project.

Social - Twitter Share Social - Twitter Follow

Quick Links

Getting Started

The following instructions will help you get started with Shards.

📦 Download

Currently there are only two ways of downloading Shards:

🖇 Dependencies

The only hard dependency is Bootstrap 4 beta which needs to be included in your HTML document before Shards. Datepickers and slider controls also require the Shards JavaScript dependency.

🏎💨 Quick Start

In order to take advantage of both Bootstrap and Shards' features you may want to use the following starter template that includes all dependencies.

<!doctype html>
<html lang="en">
  <head>
    <title>Shards — Quick Start</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

    <!-- Bootstrap and Shards CSS -->
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.2/css/bootstrap.min.css" integrity="sha384-PsH8R72JQ3SOdhVi3uxftmaW6Vc51MKb0q5P2rRUpPvrszuE4W1povHYgTpBfshb" crossorigin="anonymous">
    <link rel="stylesheet" href="/css/shards.min.css">
  </head>
  <body>
    <h1>👋 Hello! I'm using Shards and it's awesome!</h1>

    <!-- JavaScript -->
    <!-- jQuery, Popper.js, Bootstrap JS, Shards JS -->
    <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.3/umd/popper.min.js" integrity="sha384-vFJXuSJphROIrBnz7yo7oB41mKfc8JzQZiCq4NCceLEaO4IHwicKwpJf9c9IpFgh" crossorigin="anonymous"></script>
    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.2/js/bootstrap.min.js" integrity="sha384-alpBpkh1PFOepccYVYDB4do5UnbKysX5WZXm3XxPqe5iKTfUKjNkCk9SaVuEZflJ" crossorigin="anonymous"></script>
    <script src="/js/shards.min.js"></script>
  </body>
</html>

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

💁 Feedback

Building better products is something I'm trying to get really good at. I’d love to hear more about how you plan on using Shards and what features you consider important in similar products. If you could spare a few minutes, please fill out this Google Form to help me better understand your current context and what I could do to improve my 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 file for details.

Roadmap

Below are a couple of items from my list of improvements for the upcoming month(s).

General

  • Publish as an NPM package.
  • Change the license to a more permissive alternative.

Design

  • Improve the Sketch document (nested symbols).