AngularJS directives for PatternFly

This project will provide a set of common AngularJS directives for use with the PatternFly reference implementation.

Web site: https://www.patternfly.org
API Docs: http://angular-patternfly.rhcloud.com/#/api
Build Status: https://travis-ci.org/patternfly/angular-patternfly.svg?branch=master

Getting started

You have to install required software before you're able to use grunt:

Install Node.js - Find more information on Node.js
Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on NPM
Install Bower globally - Find more information on Bower
```
  npm install -g bower
```
Install Grunt globally - Find more information on Grunt
```
  npm install -g grunt-cli
```
Install npm dependencies with:
```
  npm install
```
Install bower dependencies with:
```
  bower install
```

You should have your environment ready now.

Angular-PatternFly can now be built with:

grunt build

To see all the grunt tasks that are available:

grunt help

Using Angular-PatternFly In Your Application

Note:

Add Angular and Angular-PatternFly as a dependencies for your project and you'll receive all the libraries you'll need:
```
 $ bower install angular --save
 $ bower install angular-patternfly --save
```

Add the follwing CSS include to your HTML file(s):

 <!-- Angular-PatternFly Styles -->
 <link rel="stylesheet" href="bower_components/angular-patternfly/dist/styles/angular-patternfly.min.css" />

Add the following script includes to your HTML file(s), adjusting where necessary to pull in only what you need:

 <!-- Angular-PatternFly  -->
 <script src="bower_components/angular-patternfly/dist/angular-patternfly.min.js"></script>

 <!-- C3, D3 - Charting Libraries. Only required if you are using the 'patternfly.charts' module-->
 <script src="bower_components/patternfly/components/c3/c3.min.js"></script>
 <script src="bower_components/patternfly/components/d3/d3.min.js"></script>

(optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module. In order to use patternfly charts you must add 'patternfly.charts' as a dependency in your application:
```
 my-app.module.js:

 angular.module('myApp', [
   'patternfly',
   'patternfly.charts'
 ]);
```

API documentation

The API documentation can be built with:

grunt ngdocs

If you're interested in reading the docs right away, you can use special target, which will start a web server:

grunt ngdocs:view

After executing this tasks you'll be able to access the documentation at http://localhost:8000/. If a different port is desired, it may be specified on as an option:

grunt ngdocs:view --port=8002

Releasing

Angular PatternFly is released through Bower. To release a new version version of Angular PatternFly, edit bower.json and package.json accordingly.

Update the version listed in bower.json by editing the file and changing the line:

"version": "<new_version>"

Update the patternfly reference version listed in bower.json by editing the file and changing the line below. Angular patternfly has a dependency on the patternfly reference implementation so the major and minor version numbers of the two project should be the same:

"patternfly": "<new_version>"

Update the version listed in package.json by editing the file and changing the line:

"version": "<new_version>"

Commit the version bump:

git commit -m "Version bump to <new_version>"

Publish a new set of release notes with new version as the tag version: https://github.com/patternfly/angular-patternfly/releases/new

Contributing

We're always interested in contributions from the community.

Please ensure that your PR provides the following: