An open API service indexing awesome lists of open source software.

https://github.com/cferdinandi/progress-bars

Simple CSS progress bars.
https://github.com/cferdinandi/progress-bars

Last synced: 3 months ago
JSON representation

Simple CSS progress bars.

Awesome Lists containing this project

README

          

# Progress Bars [![Build Status](https://travis-ci.org/cferdinandi/progress-bars.svg)](https://travis-ci.org/cferdinandi/progress-bars)
Simple CSS progress bars. [View the demo](http://cferdinandi.github.io/progress-bars/).

## Getting Started

Compiled and production-ready code can be found in the `dist` directory. The `src` directory contains development code.

### 1. Include Progress Bars on your site.

```html

```

### 2. Add the markup to your HTML.

Use percentages to set the widths of each bar. Add optional `.progress-bar-secondary`, `.progress-bar-success`, `.progress-bar-danger`, or `.progress-bar-warning` classes for additional colors, and to convey meaning.

```html



Basic



Secondary



Success



Danger



Warning


```

And that's it, you're done. Nice work!

## Installing with Package Managers

You can install Progress Bars with your favorite package manager.

* **NPM:** `npm install cferdinandi/progress-bars`
* **Bower:** `bower install https://github.com/cferdinandi/progress-bars.git`
* **Component:** `component install cferdinandi/progress-bars`

## Working with the Source Files

If you would prefer, you can work with the development code in the `src` directory using the included [Gulp build system](http://gulpjs.com/). This compiles, lints, and minifies code, and runs unit tests. It's the same build system that's used by [Kraken](http://cferdinandi.github.io/kraken/), so it includes some unnecessary tasks and Sass variables but can be dropped right in to the boilerplate without any configuration.

### Dependencies
Make sure these are installed first.

* [Node.js](http://nodejs.org)
* [Gulp](http://gulpjs.com) `sudo npm install -g gulp`

### Quick Start

1. In bash/terminal/command line, `cd` into your project directory.
2. Run `npm install` to install required files.
3. When it's done installing, run one of the task runners to get going:
* `gulp` manually compiles files.
* `gulp watch` automatically compiles files when changes are made and applies changes using [LiveReload](http://livereload.com/).

## Browser Compatibility

Progress Bars works in all modern browsers, and IE 6 and above.

## How to Contribute

In lieu of a formal style guide, take care to maintain the existing coding style. Please apply fixes to both the development and production code. Don't forget to update the version number, and when applicable, the documentation.

## License

The code is available under the [MIT License](LICENSE.md).