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.
Table of contents
- Quick start
- What's included
- Branch usage
- Bugs and feature requests
- Copyright and license
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
- Install with yarn:
yarn add firstname.lastname@example.org
- Install with Composer:
composer require orange-opensource/orange-boosted-bootstrap:4.1.1
- Install with NuGet: CSS:
Read the Getting started page for information on the framework contents, templates and examples, and more.
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. Bundled JS files (
boosted.bundle.js and minified
boosted.bundle.min.js) include Popper, but not jQuery.
- 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
Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set
debug: true in
Running documentation locally
- Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with
npm installto install Node.js dependencies.
- From the root
npm run docs-servein the command line.
http://localhost:9001in 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.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
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.netserver, in the
- Implementation help may be found at Stack Overflow (tagged
- Developers should use the keyword
bootstrapon packages which modify or add to the functionality of Bootstrap when distributing through npm or similar delivery mechanisms for maximum discoverability.
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.
Copyright and license
Initial code and documentation copyright 2011-2018 the Bootstrap Authors and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons. Boosted code and documentation copyright 2015-2018 the Boosted Authors and Orange SA. Code released under the MIT License. Docs released under Creative Commons.