PatternFly reference implementation
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 includes a number of dependencies that are not committed to this repository. To add them, see "Install Bower Components".
Development setup requires nodejs. If you do not already have nodejs and npm installed on your system, please see https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager for how to install on your distribution.
After ensuring nodejs and npm are available, install Bower globally:
npm install -g bower
Now that Bower is available, we can install the required development components:
bower install
At this point, you should now have a top level components/ folder with all dependencies listed in the bower.json file installed. Unless you plan to contribute to PatternFly itself, you're done. Celebrate by working on integrating PatternFly and its dependencies in your app!
The development includes the use of a number of helpful tasks. In order to setup your development environment to allow running of these tasks, you need to install the local nodejs packages declared in package.json. To do this run:
npm install
This will install all necessary development packages into node_modules/. At this point, the gruntjs tasks are available for use such as starting a local development server or building the master CSS file.
Additionally you may need to install the grunt command line utility. To do this run:
npm install -g grunt-cli
A local development server can be quickly fired up by using the Gruntjs server task:
grunt server
This local static asset server (i.e., http://localhost:9000) has the advantage of having livereload integration. Thus, if you start the Gruntjs server, any changes you make to .html or .less files will be automatically reloaded into your browser and the changes reflected almost immediately. This has the obvious benefit of not having to refresh your browser and still be able to see the changes as you add or remove them from your development files.
- Indentation
- Use spaces (not tabs)
- Indentation size is 2 spaces
- Filenames
- All filenames will use a lowercase-hyphenated naming convention (e.g., single-select-dropdown.less)
- LESSCSS
- CSS class names use lowercase-hyphenated naming convention (e.g., .navbar-nav)
- Alphabetize rules by selector
- Alphabetize properties by declaration
- Define or override variables centrally in less/variables.less
- Define or override mixins centrally in less/mixins.less
In development, styling is written and managed through multiple lesscss files. In order to generate a CSS file of all styling, run the build Gruntjs task:
grunt build
This task will compile and minify the lesscss files into a single CSS file located at dist/css/patternfly.min.css.
PatternFlyIcons font is generated using IcoMoon. Load PatternFlyIcons-webfont.json as a new project in IcoMoon and update as necessary. Please commit the updated PatternFlyIcons-webfont.json file in addition to the updated font files and supporting LESS/CSS changes.
The tests/ directory contains HTML pages with component and pattern examples in order to facilitate development. Please consult the official documentation (see below) for full details on how to use PatternFly.
See https://www.patternfly.org and http://getbootstrap.com/.
Modifications to Bootstrap are copyright 2013 Red Hat, Inc. and licensed under the Apache License 2.0.