Skip to content

Latest commit

 

History

History
230 lines (167 loc) · 9.39 KB

README.md

File metadata and controls

230 lines (167 loc) · 9.39 KB
Raw

CoreUI logo

CoreUI for React.js

React.js Components Library built on top of Bootstrap 5 and TypeScript.
Explore CoreUI for React.js docs »

Report bug · Request feature · Blog

Table of contents

Quick start

Instalation

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.

Stylesheets

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

Installation
yarn add @coreui/coreui

or

npm install @coreui/coreui --save
Basic usage
import '@coreui/coreui/dist/css/coreui.min.css'

Bootstrap CSS files

Installation
yarn add bootstrap

or

npm install bootstrap
Basic usage
import "bootstrap/dist/css/bootstrap.min.css";

Components

Status

npm version

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for React

Running documentation locally

  1. Run yarn install or npm install to install the Node.js dependencies.
  2. Run yarn bootstrap or npm run bootstrap to link local packages together and install remaining package dependencies.
  3. From the root directory, run yarn docs:dev or npm run docs:dev (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
  4. Open http://localhost:8000/ in your browser, and voilà.

Frameworks

CoreUI supports most popular frameworks.

Templates

Fully featured, out-of-the-box, templates for your application based on CoreUI.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Community

Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.

You can also follow @core_ui on Twitter.

Versioning

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.

Creators

Łukasz Holeczek

Andrzej Kopański

CoreUI Team

Support CoreUI Development

CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the CoreUI PRO or by becoming a sponsor via Open Collective.

Copyright and license

Copyright 2024 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.