React templates installation

Learn how to use CoreUI React Admin Dashboard Templates including npm scripts to build templates, compile source code, run tests, and more.

On this page

Tooling setup#

CoreUI React Admin Templates 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 our admin template locally, you'll need a copy of source files and Node. Follow these steps and you should be ready to rock:

Download and install Node.js, which we use to manage our dependencies.
If you prefer to use Yarn instead of NPM, you have to download and install it
Download CoreUI React Admin Template or Download CoreUI PRO React Admin Template.
Navigate to the root template directory and run npm install or yarn 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 or yarn run to see all the npm scripts in your terminal. Primary tasks include:

Task	Description
`npm start` or `yarn start`	Compiles CSS and JavaScript, builds the documentation, and starts a local server.
`npm run build` or `yarn build`	Creates the `dist/` directory with compiled files. Uses Sass, Autoprefixer.
`npm test` or `yarn test`	Runs tests locally

Sass#

CoreUI uses Dart Sass for compiling our Sass source files into CSS files (included in our build process), and we recommend you do the same if you're compiling Sass using your own asset pipeline.

Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don't lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.

Autoprefixer#

We uses [Autoprefixer][autoprefixer] (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.

We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See .browserslistrc.

Local template#

Here's how to get it started:

Run through the tooling setup above to install all dependencies.
From the root template directory, run npm run start or yarn start in the command line.
Open http://localhost:3000 in your browser, and voilà.

Troubleshooting#

Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun npm install or yarn install.