boosted

Orange Boosted with Bootstrap

Orange Boosted is a framework library accessible, ergonomic and Orange branded based on Bootstrap. Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.

All the core components of Bootstrap accessible and Orange branded. And also specific components only available in Boosted. Main navigation with or without Mega menu Local navigation Stepbar Orange link pagination Accordions with indicator Complex table Responsive table, display as cards onto tablets and mobile Popin (modal window) Orange branded checkboxes and radios Forms with new html5 elements and a Javascript validation Footer

To get started, check out https://boosted.orange.com/!

Table of contents

• Quick start
• Bugs and feature requests
• Documentation
• Contributing
• Versioning
• Creators
• Thanks
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap.git.
• Install with Bower: bower install boosted.
• Install with npm: npm install boosted@3.4.1.

Read the Getting started page for information on the framework contents, templates and examples, and more.

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:

boosted/
├── css/
│   ├── boosted.css
│   ├── boosted.css.map
│   ├── boosted.min.css
│   ├── boostedIE8.css
│   ├── boostedIE8.css.map
│   ├── boostedIE8.min.css
│   ├── bootstrap-orange.css
│   ├── bootstrap-orange.css.map
│   ├── bootstrap-orange.min.css
│   ├── bootstrap-orangeIE8.css
│   ├── bootstrap-orangeIE8.css.map
│   ├── bootstrap-orangeIE8.min.css
│   ├── bootstrap-orange-theme.css
│   ├── bootstrap-orange-theme.css.map
│   ├── bootstrap-orange-theme.min.css
│   ├── bootstrap-orange-themeIE8.css
│   ├── bootstrap-orange-themeIE8.css.map
│   └── bootstrap-orange-themeIE8.min.css
├── js/
│   ├── boosted.js
│   └── boosted.min.js
├── images/
│   ├── ...
│   └── ...
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    ├── glyphicons-halflings-regular.woff
    ├── glyphicons-halflings-regular.woff2
    ├── HelvNeue75_W1G.eot
    ├── HelvNeue75_W1G.svg
    ├── HelvNeue75_W1G.ttf
    ├── HelvNeue75_W1G.woff
    ├── HelvNeue75_W1G.woff2
    ├── HelvNeue55_W1G.eot
    ├── HelvNeue55_W1G.svg
    ├── HelvNeue55_W1G.ttf
    ├── HelvNeue55_W1G.woff
    ├── HelvNeue55_W1G.woff2
    ├── icon-orange.eot
    ├── icon-orange.svg
    ├── icon-orange.ttf
    └── icon-orange.woff

We provide compiled CSS and JS (*.*), as well as compiled and minified CSS and JS (*.min.*). CSS source maps (*.map) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Note that feature requests must target Bootstrap v4, because Bootstrap v3 is now in maintenance mode and is closed off to new features. This is so that we can focus our efforts on Bootstrap v4.

Documentation

Boosted's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://boosted.orange.com/. The docs may also be run locally.

Running documentation locally

1. If necessary, install Jekyll and other Ruby dependencies with bundle install. Note for Windows users: Read this guide to get Jekyll up and running without problems.
2. From the root /boosted directory, run bundle exec jekyll serve in the command line.
3. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Boosted v3 is now closed off to new features. It has gone into maintenance mode so that we can focus our efforts on Boosted v4, the future of the framework. Pull requests which add new features (rather than fix bugs) should target Bootstrap v4 (the v4-dev git branch) instead.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Boosted is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of Boosted.

Thanks

Thanks to BrowserStack for providing the infrastructure that allows us to test in real browsers!

Creators

Mark Otto

• https://twitter.com/mdo
• https://github.com/mdo

Jacob Thornton

• https://twitter.com/fat
• https://github.com/fat

Copyright and license

Code and documentation copyright 2015-2018 Orange SA. Code released under the MIT license. Docs released under Creative Commons.