Repository files navigation

Open Source UI Components Library built on top of Bootstrap 5.
Explore CoreUI docs »

Report bug ·Request feature ·Blog

• Table of contents
• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Frameworks
• Templates
• Contributing
• Community
• Versioning
• Creators
• Thanks
• Support CoreUI Development
• Copyright and license

Several quick start options are available:

• Download the latest release
• Clone the repo:git clone https://github.com/coreui/coreui.git
• Install withnpm:npm install @coreui/coreui
• Install withyarn:yarn add @coreui/coreui
• Install withComposer:composer require coreui/coreui:4.6.4

Read theGetting started page for information on the framework contents, templates and examples, and more.

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

coreui/├── css/│   ├── coreui-grid.css│   ├── coreui-grid.css.map│   ├── coreui-grid.min.css│   ├── coreui-grid.min.css.map│   ├── coreui-grid.rtl.css│   ├── coreui-grid.rtl.css.map│   ├── coreui-grid.rtl.min.css│   ├── coreui-grid.rtl.min.css.map│   ├── coreui-reboot.css│   ├── coreui-reboot.css.map│   ├── coreui-reboot.min.css│   ├── coreui-reboot.min.css.map│   ├── coreui-reboot.rtl.css│   ├── coreui-reboot.rtl.css.map│   ├── coreui-reboot.rtl.min.css│   ├── coreui-reboot.rtl.min.css.map│   ├── coreui-utilities.css│   ├── coreui-utilities.css.map│   ├── coreui-utilities.min.css│   ├── coreui-utilities.min.css.map│   ├── coreui-utilities.rtl.css│   ├── coreui-utilities.rtl.css.map│   ├── coreui-utilities.rtl.min.css│   ├── coreui-utilities.rtl.min.css.map│   ├── coreui.css│   ├── coreui.css.map│   ├── coreui.min.css│   ├── coreui.min.css.map│   ├── coreui.rtl.css│   ├── coreui.rtl.css.map│   ├── coreui.rtl.min.css│   └── coreui.rtl.min.css.map└── js/    ├── coreui.bundle.js    ├── coreui.bundle.js.map    ├── coreui.bundle.min.js    ├── coreui.bundle.min.js.map    ├── coreui.esm.js    ├── coreui.esm.js.map    ├── coreui.esm.min.js    ├── coreui.esm.min.js.map    ├── coreui.js    ├── coreui.js.map    ├── coreui.min.js    └── coreui.min.js.map

We provide compiled CSS and JS (coreui.*), as well as compiled and minified CSS and JS (coreui.min.*).source maps (coreui.*.map) are available for use with certain browsers' developer tools. Bundled JS files (coreui.bundle.js and minifiedcoreui.bundle.min.js) includePopper.

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

The documentation for the CoreUI & CoreUI PRO is hosted at our websiteCoreUI

1. Runnpm install to install the Node.js dependencies, including Hugo (the site builder).
2. Runnpm run test (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root/coreui directory, runnpm run docs-serve in the command line.
4. Openhttp://localhost:9001/ in your browser, and voilà.

Learn more about using Hugo by reading itsdocumentation.

CoreUI supports most popular frameworks.

• CoreUI for Angular
• CoreUI for Bootstrap (Vanilla JS)
• CoreUI for React
• CoreUI for Vue

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

• Angular Admin Template
• Bootstrap Admin Template
• React Admin Template
• Vue Admin Template

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

Editor preferences are available in theeditor config for easy use in common text editors. Read more and download plugins athttps://editorconfig.org/.

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

• Read and subscribe toThe Official CoreUI Blog.
• Follow@core_ui on Twitter.

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained underthe Semantic Versioning guidelines.

Seethe Releases section of our project for changelogs for each release version.

Łukasz Holeczek

• https://twitter.com/lukaszholeczek
• https://github.com/mrholek

Andrzej Kopański

• https://github.com/xidedix

CoreUI is designed as the extension ofBootstrap. Special thanks forBootstrap team andBootstrap's contributors.

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 theCoreUI PRO or by becoming a sponsor viaOpen Collective.

Support this project bybecoming a Platinum Sponsor. A large company logo will be added here with a link to your website.

Support this project bybecoming a Gold Sponsor. A big company logo will be added here with a link to your website.

Support this project bybecoming a Silver Sponsor. A medium company logo will be added here with a link to your website.

Support this project bybecoming a Bronze Sponsor. The company avatar will show up here with a link to your OpenCollective Profile.

Thanks to all the backers and sponsors! Support this project bybecoming a backer.

Copyright 2022 creativeLabs Łukasz Holeczek.This is commercial software. To use it, you have to own a commercial license. Docs released underCreative Commons.