Prerequisites

Please follow below steps to install and setup all prerequisites:

• PHP

  In order to use build tools you will need to download and install PHP. If you do not have PHP installed already, you can get it by downloading the package installer from the official website. Please download the stable version of PHP.

  Download PHP

• Node.js

  In order to use build tools you will need to download and install Node.js. If you do not have Node.js installed already, you can get it by downloading the package installer from the official website. Please download the stable version of Node.js (LTS).

  Download Node.js

• Gulp & Gulp CLI

  Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on your computer, you can skip this step. In order to install, just run command npm install -g gulp@4.0.1 from your terminal.

Installation

To setup, follow the below mentioned steps:

You can run the following commands to run project locally or build for production use:

For Windows OS:

• Unzip your project and place it inside the xampp/htdocs folder.

• You can run this app using one of these package managers Yarn, NPM.

1. Yarn

If you don't have yarn installed, use the next command npm i -g yarn or sudo npm i -g yarn

Command	Description
yarn	This would install all required dependencies in node_modules folder.
yarn dev or gulp	This would compile plugin, scss and generates css in assets folder.
yarn build or gulp build	It compiles the source assets including scss and bundles into production ready use.
yarn rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
yarn rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

2. NPM

npm comes preinstalled when you install Nodejs

Command	Description
npm i or npm i --force	This would install all required dependencies in node_modules folder.
npm run dev or gulp	This would compile all the resources from assets folder to assets folder.
npm run build or gulp build	It compiles the source assets including scss and bundles into production ready use.
npm run rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
npm run rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

• Start the Apache server from Xampp panel.

• Visit the Apache server from localhost/<project-name>/src/ after running Apache server locally

For Linux or macOS:

• You can run this app using one of these package managers Yarn, NPM.

1. Yarn

If you don't have yarn installed on your PC, use the next command npm i -g yarn or sudo npm i -g yarn

Command	Description
yarn	This would install all required dependencies in node_modules folder.
yarn dev or gulp	This would compile plugin, scss and generates css in assets folder.
cd src	Changes terminal's directory to move inside the src directory.
php -S 127.0.0.1:8000	starts the PHP server on 127.0.0.1:8000 address.
yarn build or gulp build	It compiles the source assets including scss and bundles into production ready use.
yarn rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
yarn rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

2. NPM

npm comes preinstalled when you install Nodejs

Command	Description
npm i OR npm i --force	This would install all required dependencies in node_modules folder.
npm run dev or gulp	This would compile all the resources from assets folder to assets folder.
cd src	Changes terminal's directory to move inside the src directory.
php -S 127.0.0.1:8000	starts the PHP server on 127.0.0.1:8000 address.
npm run build or gulp build	It compiles the source assets including scss and bundles into production ready use.
npm run rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
npm run rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL