boosted

Orange Boosted with Bootstrap

Boosted is a fork of Bootstrap. Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development.
Visit Boosted

Table of contents

• Quick start
• Status
• What's included
• Branch usage
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• 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 npm: npm install boosted@4.0.0-beta.2
• Install with yarn: yarn add boosted@4.0.0-beta.2
• Install with Composer: composer require orange-opensource/orange-boosted-bootstrap:4.0.0-beta.2
• Install with Bower: bower install boosted#v4.0.0-beta.2

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

Status

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
│   ├── boosted.min.css.map
│   ├── boosted-grid.css
│   ├── boosted-grid.css.map
│   ├── boosted-grid.min.css
│   ├── boosted-grid.min.css.map
│   ├── boosted-reboot.css
│   ├── boosted-reboot.css.map
│   ├── boosted-reboot.min.css
│   ├── boosted-reboot.min.css.map
│   ├── boosted-rtl.css
│   ├── boosted-rtl.min.css
│   ├── boosted-rtl.min.css.map
│   ├── orangeHelvetica.css
│   ├── orangeHelvetica.css.map
│   ├── orangeHelvetica.min.css
│   ├── orangeHelvetica.min.css.map
│   ├── orangeIcons.css
│   ├── orangeIcons.css.map
│   ├── orangeIcons.min.css
│   └── orangeIcons.min.css.map
└── js/
    ├── boosted.bundle.js
    ├── boosted.bundle.min.js
    ├── boosted.js
    └── boosted.min.js

We provide compiled CSS and JS (boosted.*), as well as compiled and minified CSS and JS (boosted.min.*). CSS source maps (boosted.*.map) are available for use with certain browsers' developer tools.

Branch usage

• master for Boosted v3.x (latest official release - only for bugfixes)
• v4-dev (default) for Boosted v4.x (Boosted next gen - following Bootstrap 4, and include new features)
• gh-pages for documentation
• patch-gridalpha.5 for Boosted v4.0.0-alpha.5.1 (patch purpose only)

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.

Documentation

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

Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set debug: true in the _scripts.html include.

Running documentation locally

1. Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with bundle install.
2. Run npm run test (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root /Orange-Boosted-Bootstrap directory, run npm run docs-serve in the command line.
4. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Documentation for v3.x has been made available for the time being at http://boosted.orange.com/docs/3.3/ while folks transition to Bootstrap 4.

Previous releases and their documentation are also available for download.

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.

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

Community

Get updates on Bootstrap's development and chat with the project maintainers and community members.

• Follow @getbootstrap on Twitter.
• Read and subscribe to The Official Bootstrap Blog.
• Join the official Slack room.
• Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##bootstrap channel.
• Implementation help may be found at Stack Overflow (tagged bootstrap-4).
• Developers should use the keyword bootstrap on packages which modify or add to the functionality of Bootstrap when distributing through npm or similar delivery mechanisms for maximum discoverability.

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. Release announcement posts on the official Bootstrap blog contain summaries of the most noteworthy changes made in each release.

Creators

Bootstrap

Mark Otto

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

Jacob Thornton

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

Boosted

Yves Gatesoupe

• https://github.com/ygatesoupe

Loïc Laussel

• http://github.com/Lausselloic/

Copyright and license

Initial code and documentation copyright 2011-2017 the Bootstrap Authors and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons. Boosted code and documentation copyright 2015-2017 the Boosted Authors and Orange SA. Code released under the MIT License. Docs released under Creative Commons.