You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
80 lines
2.9 KiB
80 lines
2.9 KiB
10 years ago
|
# react-bootstrap
|
||
|
|
|
||
|
|
[Bootstrap 3][bootstrap] components built with [React][react]
|
||
|
|
|
||
|
|
[![Travis Build Status][build-badge]][build]
|
||
|
|
[![NPM version][npm-badge]][npm]
|
||
|
|
[![Bower version][bower-badge]][bower]
|
||
|
|
[![HuBoard][huboard-badge]][huboard]
|
||
|
|
[![Gitter][gitter-badge]][gitter]
|
||
|
|
|
||
|
|
[![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.
|
||
|
|
|
||
|
|
## Docs
|
||
|
|
|
||
|
|
See the [documentation][documentation] with live editable examples.
|
||
|
|
|
||
|
|
## Authors
|
||
|
|
|
||
|
|
- [Stephen J. Collings](https://github.com/stevoland)
|
||
|
|
- [Pieter Vanderwerff](https://github.com/pieterv)
|
||
|
|
|
||
|
|
and many [contributors](https://github.com/react-bootstrap/react-bootstrap/graphs/contributors)
|
||
|
|
|
||
|
|
## Related modules
|
||
|
|
|
||
|
|
- [react-router-bootstrap][react-router-bootstrap] - Integration with [react-router][react-router].
|
||
|
|
|
||
|
|
## 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
|
||
|
|
[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
|
||
|
|
|
||
|
|
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
|
||
|
|
[gitter]: https://gitter.im/react-bootstrap/react-bootstrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
||
|
|
|
||
|
|
[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/mtscout6/react-router-bootstrap
|
||
|
|
[react-router]: https://github.com/rackt/react-router
|
||
|
|
|
||
|
|
[huboard-badge]: https://img.shields.io/badge/Hu-Board-7965cc.svg
|
||
|
|
[huboard]: https://huboard.com/react-bootstrap/react-bootstrap
|
||
|
|
|
||
|
|
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/ylitpyo6n5yq1s6i/branch/master?svg=true
|
||
|
|
[appveyor]: https://ci.appveyor.com/project/mtscout6/react-bootstrap/branch/master
|