Documentation v8.3.1

Downloads Preview

Getting Started

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

Pre Requirements

Before you install Symfony, you should check to make sure that your system has the proper prerequisites installed. These include:

PHP 8.1 or higher
Composer
Symfony CLI

Assets compile require the build tools. These libraries are required as below:

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.

Install Symfony

The Symfony CLI is a developer tool to help you build, run, and manage your Symfony applications directly from your terminal. It's Open-Source, works on macOS, Windows, and Linux, and you only have to install it once in your system.

Below is one of the installation method on Windows. For Linux or Max user installation information can be found from here: Download Symfony

Install scoop.
Open a PowerShell terminal.
```
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```
```
irm get.scoop.sh | iex
```
Then the PowerShell terminal can be closed.
Open your preferred terminal. Eg. Command Prompt or CMD. Install Symfony CLI
```
scoop install symfony-cli
```

Start the Metronic Symfony project.

cd starterkit

composer install

symfony server:start

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/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 Symfony

To run the Symfony 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
```
```
symfony server:start
```
Keep your prompt running by default application is served on http://127.0.0.1:8000