Documentation v8.2.9

Downloads Preview

Getting Started

This document is aimed to create and run your Metronic based Nodejs project in just 5 minutes. It's assumed that you already purchased Metronic and downloaded from Metronic Downloads.

Pre Requirements

HTML Features

The Starter Kit includes only the theme source code(sass, js, media, fonts and icons) from the HTML version, build tools(Gulp, Webpack), layout views and general pages(index, authentication, error) integration.

To use any feature shown in the HTML version just copy & paste the HTML code and include required assets(css, js) using the Theme Api.

Build assets

Before running the application we need to build theme assets:

Start a command prompt window or terminal and change directory to starterkit/_keenthemes/tools
```
cd starterkit/_keenthemes/tools
```
Install dependencies with either one, yarn or npm:
```
yarn install
```
You can use either one.
```
npm install
```
This command will fetch all dependencies listed in starterkit/_keenthemes/tools/package.json and place them into _keenthemes/tools/node_modules folder.
You can use Gulp or Webpack commands to bundle theme assets. The below command will compile all the assets(sass, js, media) to starterkit/public/assets folder:
For gulp use command:
```
gulp --demo1
```
For webpack use command:
```
npm run build --demo1
```
Right now supported demos are demo1 and demo30.

Note on the package.json file. This step is very important for Webpack in Metronic template. The default package.json works for Gulp. To make it work for Webpack, you have to modify tools/package.json and remove "type": "module". Otherwise, it will cause compilation error when running the build command.

Run Nodejs

To run the Nodejs application navigate your prompt to starterkit folder and run the following command. This command will listen for changes and hot reload them.

Navigate your prompt to starterkit folder.
```
cd starterkit
```
Run installation command to install depnedencies for node application.
```
yarn
```
```
npm run start
```
Keep your prompt running by default application is served on port 3000