|
| 1 | +# React-Bootstrap [![Travis][build-badge]][build] [![npm][npm-badge]][npm] |
| 2 | + |
| 3 | +[Bootstrap 3][bootstrap] components built with [React][react]. |
| 4 | + |
| 5 | +[![Codecov][codecov-badge]][codecov] |
| 6 | +[![Discord][discord-badge]][discord] |
| 7 | +[![Netlify][netlify-badge]][netlify] |
| 8 | + |
| 9 | +__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 will result in a minor version bump. |
| 10 | + |
| 11 | +## Docs |
| 12 | + |
| 13 | +See the [documentation][documentation] with live editable examples. |
| 14 | + |
| 15 | +## Related modules |
| 16 | + |
| 17 | +- [react-router-bootstrap][react-router-bootstrap] – Integration with [React Router][react-router] |
| 18 | +- [React Bootstrap Extended][react-bootstrap-extended] - A version of React Bootstrap where each component has extra props that map to bootstrap's utility classes. For example, `pullRight` adds the class `pull-right` to a component. |
| 19 | +- [Awesome React Bootstrap Components][awesome-react-bootstrap-components] - Additional components like off-canvas navbar, switch and sliders. |
| 20 | + |
| 21 | +## Local setup |
| 22 | + |
| 23 | +Yarn is the our package manager of choice here. Check out setup |
| 24 | +instructions [here](https://yarnpkg.com/en/docs/install) if you don't have it installed already. |
| 25 | +After that you can run `yarn run bootstrap` to install all the needed dependencies. |
| 26 | + |
| 27 | +From there you can: |
| 28 | + |
| 29 | +- Run the tests once with `yarn test` (Or run them in watch mode with `yarn run tdd`). |
| 30 | +- Start a local copy of the docs site with `yarn start` |
| 31 | +- Or build a local copy of the library with `yarn run build` |
| 32 | + |
| 33 | +## Contributions |
| 34 | + |
| 35 | +Yes please! See the [contributing guidelines][contributing] for details. |
| 36 | + |
| 37 | +[bootstrap]: https://getbootstrap.com/docs/3.3/ |
| 38 | +[react]: http://facebook.github.io/react/ |
| 39 | + |
| 40 | +[documentation]: http://react-bootstrap.github.io |
| 41 | +[contributing]: CONTRIBUTING.md |
| 42 | + |
| 43 | +[build-badge]: https://travis-ci.org/react-bootstrap/react-bootstrap.svg?branch=master |
| 44 | +[build]: https://travis-ci.org/react-bootstrap/react-bootstrap |
| 45 | + |
| 46 | +[npm-badge]: https://badge.fury.io/js/react-bootstrap.svg |
| 47 | +[npm]: http://badge.fury.io/js/react-bootstrap |
| 48 | + |
| 49 | +[react-router-bootstrap]: https://github.com/react-bootstrap/react-router-bootstrap |
| 50 | +[react-router]: https://github.com/reactjs/react-router |
| 51 | +[react-bootstrap-extended]: https://github.com/rbalicki2/react-bootstrap-extended |
| 52 | +[awesome-react-bootstrap-components]: https://github.com/Hermanya/awesome-react-bootstrap-components |
| 53 | + |
| 54 | +[codecov-badge]: https://img.shields.io/codecov/c/github/react-bootstrap/react-bootstrap/master.svg |
| 55 | +[codecov]: https://codecov.io/gh/react-bootstrap/react-bootstrap |
| 56 | + |
| 57 | +[discord-badge]: https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg |
| 58 | +[discord]: https://discord.gg/0ZcbPKXt5bXLs9XK |
| 59 | + |
| 60 | +[netlify-badge]: https://api.netlify.com/api/v1/badges/a74fbeb8-f950-4c97-854d-7c8363bef45e/deploy-status |
| 61 | +[netlify]: https://app.netlify.com/sites/react-bootstrap-v3/deploys |
0 commit comments