Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mgcrea/angular-touch-nav

Touch navigation plugin for AngularJS
https://github.com/mgcrea/angular-touch-nav

Last synced: 3 months ago
JSON representation

Touch navigation plugin for AngularJS

Awesome Lists containing this project

README 

        
# [ngTouchNav](https://github.com/mgcrea/angular-touch-nav) [![Build Status](https://secure.travis-ci.org/mgcrea/angular-touch-nav.png)](http://travis-ci.org/mgcrea/angular-touch-nav)



ngTouchNav is a touch navigation service written for AngularJS 1.2+ `ngRoute` & `ngAnimate` components, created and maintained by [Olivier Louvignes](http://github.com/mgcrea), inspired by [ngMobileNav](https://github.com/ajoslin/angular-mobile-nav) created by [Andy Joslin](http://github.com/ajoslin).



## Quick start



Three quick start options are available:



* [Download the latest release](https://github.com/mgcrea/angular-touch-nav/releases).

* Clone the repo: `git clone git://github.com/mgcrea/angular-touch-nav.git`.

* Install with [Bower](http://bower.io): `bower install angular-touch-nav`.



## Bugs and feature requests



Have a bug or a feature request? [Please open a new issue](https://github.com/mgcrea/angular-touch-nav/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/necolas/issue-guidelines), written by [Nicolas Gallagher](https://github.com/necolas/).



## Compiling Styles and JavaScript



This project uses [Grunt](http://gruntjs.com/) 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. Install the [necessary local dependencies](package.json) via `npm install`



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](http://npmjs.org/) and is a way to manage development dependencies through node.js. [Download and install node.js](http://nodejs.org/download/) before proceeding.



### Available Grunt commands



* Build - `grunt` - runs tests locally and compile the CSS and JavaScript into `/dist`.

* Compile - `grunt build` - creates the `/dist` directory with compiled files.

* Tests - `grunt test` - runs jshint and unit tests headlessly in [phantomjs](https://github.com/ariya/phantomjs/) (used for CI).

* Watch - `grunt watch` - watching 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`.



## Contributing



Please read through our guidelines for contributing. Included are directions for opening issues, coding standards, and notes on development.



More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests.



Editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at [http://editorconfig.org](http://editorconfig.org).



## Versioning



For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.



Releases will be numbered with the following format:



`..`



And constructed with the following guidelines:



* Breaking backward compatibility bumps the major (and resets the minor and patch)

* New additions without breaking backward compatibility bumps the minor (and resets the patch)

* Bug fixes and misc changes bumps the patch



For more information on SemVer, please visit [http://semver.org/](http://semver.org/).



## Authors



**Olivier Louvignes**



+ [http://twitter.com/olouv](http://twitter.com/olouv)

+ [http://github.com/mgcrea](http://github.com/mgcrea)



## Copyright and license



Copyright 2013 Olivier Louvignes under [MIT license](LICENSE.md).