Get Started

Introduction

One detail introduction about this showcase.
This project will provide a set of common AngularJS directives and service for use with the PatternFly reference implementation.

Installation

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

  • Install Node.js - Find more information on Node.js
    Angular Patternfly stays up to date with the Node LTS Release Schedule. If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work.
  • Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on NPM
  • Install Grunt globally - Find more information on Grunt 
    $ npm install-g grunt-cli
    Install npm dependencies with: 
    $ npm install
    You should have your environment ready now.
    Angular-PatternFly can now be built with: 
    $ npm run build
    To see all the grunt tasks that are available: 
    $ npm run help

Usage

  1. Add Angular and Angular-PatternFly as dependencies for your project and you'll receive all the libraries you'll need: 
    $ npm install angular --save 
    $ npm install angular-patternfly --save
  2. Add the core Patternfly CSS and script includes to your HTML file(s):
    Please see: https://github.com/patternfly/patternfly/blob/master/QUICKSTART.md
  3. Add the following CSS include to your HTML file(s): 
    <!-- Angular-PatternFly Styles -->
    <link rel="stylesheet" href="node_modules/angular-patternfly/dist/styles/angular-patternfly.min.css" />
  4. Add the following script includes to your HTML file(s), adjusting where necessary to pull in only what you need: 
    <!-- Angular -->
    <script src="node_modules/angular-patternfly/node_modules/angular/angular.min.js"></script>
								
    <!-- Angular-Bootstrap -->
    <script src="node_modules/angular-patternfly/node_modules/angular-ui-bootstrap/dist/ui-bootstrap.js"></script>