core-logo

Build tools

Learn how to use CoreUI Icons's included npm scripts to compile source code, run tests, and more.

On this page:



Tooling setup

CoreUI Icons 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 documentation locally, you’ll need a copy of CoreUI Icons’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. Navigate to the root /coreui-icons 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 the following commands and tasks:

Task Description
npm run build npm run dist creates the /css/ directory with compiled files. Uses Sass, Autoprefixer, and terser.

Run npm run to see all the npm scripts.

Autoprefixer

CoreUI Icons uses Autoprefixer (included in our build process) to automatically add vendor prefixes to some CSS properties at build time.

Troubleshooting

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