@shore/bootstrap

v3.3.5-shore.76

Published

5 months ago

The most popular front-end framework for developing responsive, mobile first projects on the web.

Downloads

399

THIS IS A CUSTOM VERSION OF BOOTSTRAP USED BY SHORE

At Shore we create our own builds of Bootstrap. We do this for several reasons:

maintain our custom Shore theme
select only the features we need
add custom element styles
distribute as npm private module, so that we can easily use it in multiple projects to ensure a consistent brand experience

Visit the Shore Bootstrap Theme Test Page hosted on Shore CDN!

Usage

Install via npm with

npm install @shore/[email protected] (replace N with latest version)

and use the files from dist folder.

Development

Use the shore-bootstrap3 branch as a basis. Do not commit your changes to master!

Install the required npm packages from the project root via:

npm install

Simple theme testing

Execute

npm run test-server

to open the theme test page and start hacking the less files. The test-server will watch for files changes and autom. reloads the test page.

How to update the Shore Icon Font?

Go to Fontastic
Make sure shore-icons is selected (top-left, below Fontastic logo)
Select new icons
Go to Publish page
Click on DOWNLOAD button
Extract ZIP file and copy folder shore-icons to project root folder
run npm run -s generate-shore-icons-less

Build

npm run build

Publishing on NPM

This has to be done locally by calling npm publish.

What's happening:

bump version to 3.3.5-shore.(n+1)
git push (with tags)
publish on npm

Bootstrap

Bower version

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.

To get started, check out http://getbootstrap.com!

Quick start

Several quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/twbs/bootstrap.git.
Install with Bower: bower install bootstrap.
Install with npm: npm install bootstrap.
Install with Meteor: meteor add twbs:bootstrap.
Install with Composer: composer require twbs/bootstrap.

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:

bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   ├── bootstrap-theme.css.map
│   └── bootstrap-theme.min.css
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2

We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). CSS source maps (bootstrap.*.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.

Documentation

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

Running documentation locally

If necessary, install Jekyll (requires v2.5.x).

Windows users: Read this unofficial guide to get Jekyll up and running without problems.

Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
From the root /bootstrap directory, run jekyll serve in the command line.
Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Documentation for v2.3.2 has been made available for the time being at http://getbootstrap.com/2.3.2/ while folks transition to Bootstrap 3.

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 twitter-bootstrap-3).
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, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Mark Otto

Jacob Thornton