Kapsiki Design React
[Kapsiki Design 1][kapsiki-design] components built with [React][react].
[![GitHub Actions CI status][gh-actions-badge]][gh-actions] [![Travis CI Build status][travis-badge]][travis] [![npm][npm-badge]][npm] [![Codecov][codecov-badge]][codecov] [![Discord][discord-badge]][discord] [![Netlify][netlify-badge]][netlify]
Kapsiki Design compatibility
Kapsiki Design React is compatible with various versions of Kapsiki Design. As such, you need to ensure you are using the correct combination of versions.
See the below table on which version of Kapsiki Design React you should be using in your project.
| Kapsiki Design Version | Kapsiki Design React Version | Documentation |
|---|---|---|
| v5.x | 2.x | [Link][v5-documentation] |
| v4.x | 1.x | [Link][v4-documentation] |
| v3.x | 0.33.x (not maintained) | [Link][v3-documentation] |
Migrating from previous versions
Kapsiki Design 4 to Kapsiki Design 5
If you would like to update Kapsiki Design React within an existing project to use Kapsiki Design 5, please read our docs for [migrating to Kapsiki Design React V2][v5-migration].
Kapsiki Design 3 to Kapsiki Design 4
If you would like to update Kapsiki Design React within an existing project to use Kapsiki Design 4, please read our docs for [migrating to Kapsiki Design React V1][v4-migration].
Related modules
- [react-router-bootstrap][react-router-bootstrap] – Integration with [React Router][react-router]
- [Awesome React Kapsiki Design Components][awesome-kapsiki-design-react-components] - Additional components like off-canvas navbar, switch and sliders.
Local setup
Yarn is our package manager of choice here. Check out setup
instructions here if you don't have it installed already.
After that you can run yarn run kapsiki-design to install all the needed dependencies.
From there you can:
- Run the tests once with
yarn test(Or run them in watch mode withyarn run tdd). - Start a local copy of the docs site with
yarn start - Or build a local copy of the library with
yarn run build