react-bootstrap/README.md

Bootstrap 3 components built with React

# react-bootstrap

[Bootstrap 3][bootstrap] components built with [React][react].

[![Travis Build Status][build-badge]][build]
[![Build status][appveyor-badge]][appveyor]
[![Coverage Status][coveralls-badge]][coveralls]  
[![Discord][discord-badge]][discord]
[![Thinkful][thinkful-badge]][thinkful]  
[![NPM version][npm-badge]][npm]
[![Bower version][bower-badge]][bower]  
[![Dependency Status][deps-badge]][deps]
[![devDependency Status][dev-deps-badge]][dev-deps]
[![peerDependency Status][peer-deps-badge]][peer-deps]

__Under active development - APIs will change.__ Check out the [1.0.0 Roadmap](https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap) and [Contributing Guidelines][contributing] to see where you can help out. Prior to the 1.0.0 release, deprecations or breaking changes should result in a Minor version bump.

## Docs

See the [documentation][documentation] with live editable examples.

## Related modules

- [react-router-bootstrap][react-router-bootstrap] - Integration with [react-router][react-router].
- [Complementary Tools][complementary-tools] - List of complementary tools that
  can be used with React.

## Local Setup

- Install the dependencies with `npm install`
- Run tests `npm test`
- Run tests in watch mode `npm run test-watch`
- Run the docs site in development mode with `npm run docs`. This will watch
  for file changes as you work. Simply refresh the page to see the updates.
- Build with `npm run build`

## Contributions

Yes please! See the [contributing guidelines][contributing] for details.

[bootstrap]: http://getbootstrap.com
[react]: http://facebook.github.io/react/

[documentation]: http://react-bootstrap.github.io
[contributing]: https://github.com/react-bootstrap/react-bootstrap/blob/master/CONTRIBUTING.md

[build-badge]: https://travis-ci.org/react-bootstrap/react-bootstrap.svg?branch=master
[build]: https://travis-ci.org/react-bootstrap/react-bootstrap

[npm-badge]: https://badge.fury.io/js/react-bootstrap.svg
[npm]: http://badge.fury.io/js/react-bootstrap

[bower-badge]: https://badge.fury.io/bo/react-bootstrap.svg
[bower]: http://badge.fury.io/bo/react-bootstrap

[deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap.svg
[deps]: https://david-dm.org/react-bootstrap/react-bootstrap

[dev-deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap/dev-status.svg
[dev-deps]: https://david-dm.org/react-bootstrap/react-bootstrap#info=devDependencies

[peer-deps-badge]: https://david-dm.org/react-bootstrap/react-bootstrap/peer-status.svg
[peer-deps]: https://david-dm.org/react-bootstrap/react-bootstrap#info=peerDependencies

[react-router-bootstrap]: https://github.com/react-bootstrap/react-router-bootstrap
[react-router]: https://github.com/rackt/react-router

[complementary-tools]: https://github.com/facebook/react/wiki/Complementary-Tools

[thinkful-badge]: https://tf-assets-staging.s3.amazonaws.com/badges/thinkful_repo_badge.svg
[thinkful]: http://start.thinkful.com/react/?utm_source=github&utm_medium=badge&utm_campaign=react-bootstrap

[appveyor-badge]: https://ci.appveyor.com/api/projects/status/ylitpyo6n5yq1s6i/branch/master?svg=true
[appveyor]: https://ci.appveyor.com/project/react-bootstrap/react-bootstrap/branch/master

[coveralls-badge]: https://coveralls.io/repos/react-bootstrap/react-bootstrap/badge.svg?branch=master&service=github
[coveralls]: https://coveralls.io/github/react-bootstrap/react-bootstrap?branch=master

[discord-badge]: https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg
[discord]: https://discord.gg/0ZcbPKXt5bXLs9XK