decks/README.md

JavaScript UI library for viewing collections of items.

# decks

[![Build Status](http://img.shields.io/travis/pellucidanalytics/decks.svg)](https://travis-ci.org/pellucidanalytics/decks)

[![npm version](http://img.shields.io/npm/v/decks.svg)](https://www.npmjs.org/package/decks)
[![Dependency Status](http://img.shields.io/david/pellucidanalytics/decks.svg)](https://david-dm.org/pellucidanalytics/decks)
[![devDependency Status](http://img.shields.io/david/dev/pellucidanalytics/decks.svg)](https://david-dm.org/pellucidanalytics/decks#info=devDependencies)
[![npm license](http://img.shields.io/npm/l/decks.svg)](https://www.npmjs.org/package/decks)

[![Sauce Test Status](https://saucelabs.com/browser-matrix/pelluciddecks.svg?auth=ece3dc76af60a49515da2a7b0bbfa51c)](https://saucelabs.com/u/pelluciddecks?auth=ece3dc76af60a49515da2a7b0bbfa51c)

## Overview

A flexible layout library for rendering collections of items in the DOM.

## Getting started

```sh
git clone https://github.com/pellucidanalytics/decks.git
cd decks
npm install

# Default build for development (file watcher)
# This builds the lib code, tests, and examples, and sets up file
# watchers and LiveReload for development.
gulp

# Build the distributable library code (built to ./dist)
gulp lib

# Build and run the tests (built to ./dist/test)
gulp test

# Build the examples (built to ./dist/examples)
gulp examples

# Publish the repository to npm (maintainers only)
gulp publish
```

## Documentation

- [Docs](https://pellucidanalytics.github.io/decks)

## Inspirations

- [Tremula](https://github.com/garris/TremulaJS)
- [Stapel](http://tympanus.net/Development/Stapel/)
- [gridster.js](http://gridster.net/)
- [jquery.shapeshift](http://mcpants.github.io/jquery.shapeshift/)
- [jQuery Nested](http://suprb.com/apps/nested/)
- [Free Wall](http://vnjs.net/www/project/freewall/)
- [Shuffle](http://vestride.github.io/Shuffle/)
- [Loading Effects for Grid Items](http://tympanus.net/Development/GridLoadingEffects/index.html)
- [Magnet](http://codecanyon.net/item/magnet-jquery-plugin-for-filterable-layouts/full_screen_preview/7550966?ref=jqueryrain)
- [jQuery Gridly](http://ksylvest.github.io/jquery-gridly/)