W3CoreUI

Quick Setup

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

Install the gulp command from your PC terminal

C:\Users\user_name>
npm install --global gulp-cli

Install the gulp command from your PC terminal

/Users/your_username ~ %
sudo npm install --global gulp-cli

Install the gulp command from your PC terminal

/home/your_username ~/
npm install --global gulp-cli

In your terminal or command prompt:

cd /your-project-directory/>
 npm install

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

Run the following command to start the live preview server:

cd /your-project-directory/>
 gulp

To compile and optimize all files for production:

gulp build

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`

Get started quickly with W3CoreUI by following the essential setup steps for seamless integration.

Organize your project efficiently by following the recommended File Structure for better maintainability and scalability.
W3CoreUI offers a customizable UI with light & dark modes, color variants, flexible layouts, and responsive design. Refer to the Theme Features guide for setup.
Set up Sass compilation to generate the necessary styles for your project.
Check the Template Markup guide and include all required and optional assets in your project.
Refer to the Dark Mode guide if your project requires Dark Mode support.
For further assistance, please reach out to the core team by submitting a ticket through the Support Panel.