@coreui/coreui-pro NPM

CoreUI - WebApp UI Kit built on top of Bootstrap 4

Please help us on Product Hunt and Designer News. Thanks in advance!

Curious why I decided to create CoreUI? Please read this article: Jack of all trades, master of none. Why Bootstrap Admin Templates suck.

CoreUI is an Open Source UI Kit built on top of Bootstrap 4. CoreUI is the fastest way to build modern dashboard for any platforms, browser or device. A complete Dashboard and WebApp UI Kit that allows you to quickly build eye-catching, high-quality, high-performance responsive applications using your framework of choice.

Templates

Admin Templates built on top of CoreUI Pro

CoreUI Pro	Prime	Root	Alba	Leaf

Installation

Several options are available:

Clone repo

$ git clone https://github.com/coreui/coreui.git

NPM

$ npm install @coreui/coreui --save

Yarn

$ yarn add @coreui/coreui@2.1.4

Composer

$ composer require coreui/coreui:2.1.4

Usage

CSS

Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.

<link rel="stylesheet" href="node_modules/@coreui/coreui-pro/dist/css/coreui.min.css">

JS

Many of our components require the use of JavaScript to function. Specifically, they require jQuery, Popper.js, Bootstrap and our own JavaScript plugins. Place the following <script>s near the end of your pages, right before the closing </body> tag, to enable them. jQuery must come first, then Popper.js, then Bootstrap, and then our JavaScript plugins.

<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/popper.js/dist/umd/popper.min.js"></script>
<script src="node_modules/bootstrap/dist/js/bootstrap.min.js"></script>
<script src="node_modules/@coreui/coreui-pro/dist/js/coreui.min.js"></script>

What's included

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/
├── build/
├── dist/
├── js/
└── scss/

Documentation

The documentation for the CoreUI Free Bootstrap Admin Template is hosted at our website 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 http://editorconfig.org.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under the Semantic Versioning guidelines.

See the Releases section of our project for changelogs for each release version.