Metronic Documentation | Keenthemes
logo
The World’s #1 Bootstrap 5 HTML, VueJS, React, Angular & Laravel
Admin Dashboard Ecosystem

This is Metronic 7 documentation!

Upon purchase you can get Metronic 7 version from our Github Repository.
Request Github access
The new Metronic 8 is now available with the most advanced Bootstrap 5, VueJS, React and Laravel foundation with a solid light and dark mode design system, extensive utility classes and custom made in-house components.
View Metronic 8 documentation

To use most of the Metronic build tools, Node.js LTS version is required. Version 14.x LTS is recommended. Some of the plugins and framework in Metronic v7 does not support the latest Node.js version. https://nodejs.org/en/

Gulp Quick Start

In order to launch the theme you will need to generate the assets folder from src folder by installing and running the build tools in command line. The steps below for the Default jQuery Package. If you want to use the Webpack, go to this Webpack Quick Start section.

  1. Download the latest theme source from the marketplace.

  2. Download and install Node.js from nodejs.org/en/download/. The suggested version to install is 14.15.x LTS.

  3. Start command prompt window or terminal and change directory to [metronic]/theme/html/tools/

    cd theme/html/tools
  4. Install the latest npm.

    npm install --global npm@latest
  5. Install yarn via the npm.

    npm install --global yarn

    Don't forget to run yarn upgrade after every Metronic updates released in order to install newly added or updated 3rd-party plugins.
    Use npm cache clean --force command, if installation had failed at any step. Retry from start after it done.

  6. Gulp is a toolkit that helps you automate your time-consuming tasks in development workflow. To install gulp globally.

    npm install --global gulp-cli

    If you have previously installed a version of gulp globally, remove it to make sure old version doesn't collide with new gulp-cli.

    npm rm --global gulp

    Verify that gulp in successfully installed, and version of installed gulp will appear.

    gulp --version
  7. Install yarn dependencies. Must execute in [metronic]/theme/html/tools/ folder.

    yarn
  8. This below command will compile all the assets(sass, js, media) to [metronic]/theme/html/[demo]/dist/assets folder. State which demo to compile and append at the of the command. Eg. --demo1

    gulp --demo1

    If you had any error at this step during compilation. Try to update gulp to the latest version. npm install --global gulp-cli

  9. Start the localhost server.

    gulp localhost --demo1

    Keep the console open. Open this link to run http://localhost:8080/. It will take a few seconds for the build to finish.

    Press Ctrl+C to quit from localhost.

For more information about the Gulp build tool, click here.

Think About The Future, Stay Connected With Us
The More We Learn, The More We Are Able To Innovate & To Develop