Skip to content

Latest commit

 

History

History
105 lines (75 loc) · 6.05 KB

QUICKSTART.md

File metadata and controls

105 lines (75 loc) · 6.05 KB
Raw

Using PatternFly - Quick Start Guide

This reference implementation of PatternFly is based on Bootstrap v3. Think of PatternFly as a "skinned" version of Bootstrap with additional components and customizations. PatternFly is meant to be used as a replacement for Bootstrap, so please don't include the Bootstrap CSS if you are including the PatternFly CSS in your project.

What's Included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

patternfly/
├── components/
│   ├── third-party repos (may need to pull in additional JS includes based on usage, but no additional CSS includes are needed)
├── dist/
│   ├── css/
│   │   │── patternfly.min.css (* need to include)
│   │   │── patternfly-additions.min.css (* need to include)
│   └── fonts/
│   │   │── font and icon libraries (included via above CSS)
│   └── img/
│   │   │── branding materials and loading indicators
│   └── js/
│   │   │── patternfly.min.js (may need to include if you are using PatternFly jQuery Sidebar, Popovers or Datatables)
├── less/
│   ├── variables, mixin, and component Less files (may need to include if you want to customize the already built CSS)
└── test-src/
    ├── example markup source files

We provide compiled CSS and JS (patternfly.*), as well as compiled and minified CSS and JS (patternfly.min.*). CSS source maps (patternfly.*.map) are available for use with certain browsers' developer tools. Fonts from OpenSans, FontAwesome, PatternFly Icons are included, as well as numerous other 3rd party JS components and libraries.

Using PatternFly In Your Application

  1. Ensure you have installed the following utilities:

    • Git: a free and open source distributed version control system.

    • Node.js: a software platform that is used to build server-side applications.

    • Grunt: a JavaScript task runner.

        $ sudo npm install -g grunt-cli

    • Bower: a package manager for the web.

  2. Add PatternFly as a dependency for your project and you'll receive all the libraries you'll need:

     $ bower install patternfly --save

    For full install options see the README

  3. Add the follwing CSS includes to your HTML file(s), adjusting path where needed:

     <!-- PatternFly Styles -->
 <!-- Note: No other CSS files are needed regardless of what other JS packages located in patternfly/components that you decide to pull in -->
 <link rel="stylesheet" href="bower_components/patternfly/dist/css/patternfly.min.css" />
 <link rel="stylesheet" href="bower_components/patternfly/dist/css/patternfly-additions.min.css" />

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

     <!-- jQuery -->
 <script src="bower_components/patternfly/components/jquery/dist/jquery.js"></script>

 <!-- Bootstrap JS -->
 <script src="bower_components/patternfly/components/bootstrap/dist/js/bootstrap.js"></script>

 <!-- C3, D3 - Charting Libraries -->
 <script src="bower_components/patternfly/components/c3/c3.min.js"></script>
 <script src="bower_components/patternfly/components/d3/d3.min.js"></script>

 <!-- Datatables, jQuery Grid Component -->
 <!-- Note: jquery.dataTables.js must occur in the html source before patternfly*.js.-->
 <script src="bower_components/patternfly/components/datatables/media/js/jquery.dataTables.js"></script>
 <script src="bower_components/patternfly/components/datatables-colvis/js/dataTables.colVis.js"></script>
 <script src="bower_components/patternfly/components/datatables-colreorder/js/dataTables.colReorder.js"></script>

 <!-- PatternFly Custom Componets -  Sidebar, Popovers and Datatables Customizations -->
 <!-- Note: jquery.dataTables.js must occur in the html source before patternfly*.js.-->
 <script src="bower_components/patternfly/dist/js/patternfly.js"></script>

 <!-- Bootstrap Combobox -->
 <script src="bower_components/patternfly/components/bootstrap-combobox/js/bootstrap-combobox.js"></script>

 <!-- Bootstrap Date Picker -->
 <script src="bower_components/patternfly/components/bootstrap-datepicker/dist/js/bootstrap-datepicker.min.js"></script>

 <!-- Bootstrap Select -->
 <script src="bower_components/patternfly/components/bootstrap-select/dist/js/bootstrap-select.min.js"></script>

 <!-- Bootstrap Switch -->
 <script src="bower_components/patternfly/components/bootstrap-switch/dist/js/bootstrap-switch.min.js"></script>

 <!-- Bootstrap Touchspin -->
 <script src="bower_components/patternfly/components/bootstrap-touchspin/dist/jquery.bootstrap-touchspin.min.js"></script>

 <!-- Bootstrap Tree View -->
 <script src="bower_components/patternfly/components/bootstrap-treeview/dist/bootstrap-treeview.min.js"></script>

 <!-- Google Code Prettify - Syntax highlighting of code snippets -->
 <script src="bower_components/patternfly/components/google-code-prettify/bin/prettify.min.js"></script>

 <!-- MatchHeight - Used to make sure dashboard cards are the same height -->
 <script src="bower_components/patternfly/components/matchHeight/jquery.matchHeight.js"></script>

 <!-- Angular Application? You May Want to Consider Pulling Angular-PatternFly And Angular-UI Bootstrap instead of bootstrap.js -->
 <!-- See https://github.com/patternfly/angular-patternfly for more information -->

  5. Enjoy!!!