Documentation v8.2.9

Downloads Preview

Getting Started

This document is aimed to run your Metronic based Spring Boot 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 your command line interface and change directory to starterkit/_keenthemes/tools.
```
cd Starterkit/_keenthemes/tools
```
Install dependencies with either one, yarn or npm.
Yarn command:
```
yarn install
```
Npm command:
```
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 The below command will compile all the assets(sass, js, media) to Starterkit/wwwroot/assets folder:
For gulp use command:
```
gulp
```
For webpack use command:
```
npm run build
```
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 application

To run application navigate your terminal window to starterkit folder and run command mvn spring-boot:run. Keep your terminal window runing, by default Tomcat is served on port 8080.

mvn spring-boot:run