• AngularJS v1.0.0+ is currently required.
• jQuery / Plugins (depends on directive). Check specific directive dependencies for more information

The repository comes with the modules pre-built and compressed into the build/ directory.

angular.module('myApp', ['ui']);

The modules can be found in the Directives and Filters folders. Check out the readme file associated with each module for specific module usage information.

You do not need to build the project to use it - see above - but if you are working on it then this is what you need to know.

0. Install Node.js and NPM (should come with)

1. Install local dependencies:

$ npm install

2. Install global dependencies grunt, coffee-script, and testacular:

$ npm install -g testacular coffee-script grunt

Before you commit, always run grunt to build and test everything once.

$ grunt

The modules come with unit tests that should be run on any changes and certainly before commiting changes to the project. The unit tests should also provide further insight into the usage of the modules.

First, start the testacular server:

$ grunt server

Then, open your browser to http://localhost:8080 and run the watch command to re-run tests on every save:

$ grunt watch

For core team: if you wish to publish a new version follow these steps:

1. Bump the version number inside package.json
2. Build and test
3. Commit the updated package.json and build/ folder on their own commit
4. Tag the commit: git tag v[maj].[min].[patch]
5. Push the tag: git push [angular-ui] master --tags