CoreUI PRO Bootstrap Admin Template is built on top of CoreUI PRO UI Components Library, so if you're looking for documentation for a specific component please check this documentation.

Installation

CoreUI PRO Bootstrap Admin Template can be installed in two ways.

Download

Visit our website to download the latest version.

Download

Clone repo

Only for clients with active subscription.

 # clone the repo
                  $ git clone https://github.com/coreui/coreui-pro-bootstrap-admin-template.git my-project

                  # go into app's directory
                  $ cd my-project

                  # install app's dependencies
                  $ npm install

Usage

Tooling setup

CoreUI Admin Template uses npm scripts for its build system. Our package.json includes convenient methods for working with the framework, including compiling code, running tests, and more.

To use our build system and run template locally, you’ll need a copy of CoreUI’s source files and Node. Follow these steps and you should be ready to rock:

1. Download and install Node.js, which we use to manage our dependencies.
2. Either download CoreUI’s sources or fork CoreUI’s repository.
3. Navigate to the root /coreui-free-bootstrap-admin-template directory and run npm install to install our local dependencies listed in package.json.

When completed, you’ll be able to run the various commands provided from the command line.

Using npm scripts

Our package.json includes numerous tasks for developing the project. Run npm run to see all the npm scripts in your terminal. Primary tasks include:

Task	Description
npm start	Compiles CSS and JavaScript, and starts a local server.
npm run build	Creates the dist/ directory with compiled files. Requires Sass, Autoprefixer.
npm run serve	Start a local server for files in dist folder.

Contents

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-pro-bootstrap-admin-template/
                ├── build/
                ├── src/
                │ ├── assets/
                │ │ ├── brand/
                │ │ ├── favicon/
                │ │ ├── icons/
                │ │ ├── img/
                │ ├── js/
                │ ├── pug/
                │ │ ├── _layout/
                │ │ ├── _partial/
                │ │ ├── base/
                │ │ ├── buttons/
                │ │ ├── icons/
                │ │ ├── notifications/
                │ │ ├── ...
                │ │ ├── index.pug
                │ │ └── ...
                │ ├── scss/
                │ ├── vendors/
                │ └── views/
                │ ├── base/
                │ ├── buttons/
                │ ├── css/
                │ ├── icons/
                │ ├── notifications/
                │ ├── ...
                │ ├── index.html
                │ └── ...
                └── package.json