keyboard_double_arrow_left
help Help & getting started
  1. Home
  2. Gulp JS

Gulp Quick Start

This guide will help you set up and run the project using Gulp for development and production.

1.- Install Node.js

  • Make sure Node.js is installed.

  • Recommended version: Node.js 16.x LTS or later.

  • Download from: https://nodejs.org

2.- Install Dependencies

In your terminal or command prompt:

cd /your-project/
 npm install

This will install all required npm packages listed in package.json.

3.- Start Development Server

Run the following command to start the live preview server:

gulp
This will:

  • Compile SCSS (LTR only)

  • Include HTML partials using @@include()

  • Copy assets and images to .temp/

  • Launch a browser preview with live reload

  • Watch for file changes (HTML, SCSS, Images)

4.- Build

To compile and optimize all files for production:

gulp build
This will:

  • Compile and minify SCSS, JS, and HTML

  • Generate both LTR and RTL CSS versions

  • Copy all assets (images, icons, SCSS, JS)

  • Replace node_modules paths with assets/vendor

  • Output will be in the dist/ folder, ready for deployment.

5.- Available Gulp Commands (Optional)
Command Description
gulp Start development server with live reload
gulp build Create full production build
gulp cleanDist Remove dist/ folder
gulp compileSCSS Compile SCSS files manually
gulp FileIncludeHtml Compile HTML with partials
gulp dzVendor Copy vendor libraries from node_modules