Giters

doyleindustries / leapstrap

Leapstrap - Leap Motion HTML5 CSS web frontend framework. Based on Bootstrap.

Home Page:http://wilkesalex.github.io/leapstrap

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Leapstrap

##Leap Motion HTML5 CSS web frontend framework. Based on Twitter Bootstrap, LeapJS and more. ###Leapstrap brings the power of touch to your website in an extensive yet easy to use HTML5 framework, eliminating the need for installing Leap apps (through Airspace).

--

Get a Leap Motion Controller, get Leapstrap and put your fingers to work. Leapstrap provides complete HTML5 front-end interactivity for Leap Motion® devices and controllers. If you want to use a Leap® with your website, Leapstrap is for you. Created and maintained by Alex Wilkes. Based on Twitter Leapstrap, LeapJS and Leap Cursor Library. Touch the web today!

To get started, check out http://wilkesalex.github.io/leapstrap !

Quick start

These quick start options are available:

Then:

  • Attach the Leapstrap CSS, JS and initalising script to your page
  • Give elements a class of leap-interactive
  • Use Leap to browse and interact!

Read the Getting Started page for more information.

Bugs and feature requests

Have a bug or a feature request? Please open a new issue.

Documentation

Leapstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://wilkesalex.github.io/leapstrap/. The docs may also be run locally.

Running documentation locally

  1. If necessary, install Jekyll (requires v1.x).
  2. From the root /leapstrap directory, run jekyll serve in the command line.
  • Windows users: run chcp 65001 first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors.
  1. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Compiling CSS and JavaScript

Leapstrap uses Grunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.

Install Grunt

From the command line:

  1. Install grunt-cli globally with npm install -g grunt-cli.
  2. Navigate to the root /leapstrap directory, then run npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.

When completed, you'll be able to run the various Grunt commands provided from the command line.

Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Available Grunt commands

Build - grunt

Run grunt to run tests locally and compile the CSS and JavaScript into /dist. Uses recess and UglifyJS.

Only compile CSS and JavaScript - grunt dist

grunt dist creates the /dist directory with compiled files. Uses recess and UglifyJS.

Tests - grunt test

Runs JSHint and QUnit tests headlessly in PhantomJS (used for CI).

Watch - grunt watch

This is a convenience method for watching just Less files and automatically building them whenever you save.

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Community

Keep track of development and community news.

With Thanks

Twitter Leapstrap

Leap JS

leap-cursor-library

Copyright and license

Copyright 2013 Alex Wilkes. Further License Information TBC.

About

Leapstrap - Leap Motion HTML5 CSS web frontend framework. Based on Bootstrap.

http://wilkesalex.github.io/leapstrap