CoreUI for React.js
Table of contents
- Quick start
- What's included
- Bugs and feature requests
- Copyright and license
Several quick start options are available:
- Download the latest release
- Clone the repo:
git clone https://github.com/coreui/coreui-react.git
- Install with npm:
npm install @coreui/react
- Install with yarn:
yarn add @coreui/react
Read the Getting started page for information on the framework contents, templates and examples, and more.
React components are styled using
@coreui/coreui CSS library, but you can use them also with bootstrap CSS library. That is possible because
@coreui/coreui library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
CoreUI CSS files
yarn add @coreui/coreui
npm install @coreui/coreui --save
Bootstrap CSS files
yarn add bootstrap
npm install bootstrap
Bugs and feature requests
The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for React
Running documentation locally
npm installto install the Node.js dependencies.
npm run bootstrapto link local packages together and install remaining package dependencies.
- From the root directory, run
http://localhost:8000/in your browser, and voilà.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
- Read and subscribe to The Official CoreUI Blog.
You can also follow @core_ui on Twitter.
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under the Semantic Versioning guidelines.
See the Releases section of our project for changelogs for each release version.
The CoreUI Team