Setup

We are using gulp which allows to have complete automatation for build flow. In case if you don't know - Gulp is a toolkit for automating painful or time-consuming tasks in development workflow, so you can stop messing around and build something. You can read it more about it here. Please follow below steps to install and setup all prerequisites:

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.

  • Symfony CLI

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

    Download Symfony CLI

Installation

To setup, follow the below mentioned steps:

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

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 public folder.
yarn build or gulp build It compiles the assets including scss and bundles into production ready use.
yarn rtl or gulp rtl

This would compile plugin, scss and generates rtl css in public folder.

yarn rtl-build or gulp rtlBuild

It compiles the 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 in public folder.
npm run build or gulp build It compiles the 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 public folder.

npm run rtl-build or gulp rtlBuild

It compiles the assets including scss and bundles into production ready use RTL

To spin up the Symfony development server, follow the below mentioned steps in a separate terminal:

Command Description
composer i It will install all dependencies in vendor folder.
symfony server:start Runs the project locally, starts the development server.
© 2014 - Inspinia By WebAppLayers
10GB of 250GB Free.