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:
Please follow below steps to install and setup all prerequisites:
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.jsMake 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.
You can run the following commands to run project locally or build for production use:
If you don't have yarn installed on your
PC, use the yarn i -g bun or sudo npm i -g yarn to install
| Command | Description |
|---|---|
yarn |
This would install all required dependencies node_modules folder.. |
gulp |
This would compile all the resources from assets folder to
public
folder.
|
yarn dev |
Runs the project locally, starts the node development server. |
gulp build |
It bundles with production mode. Your app is now ready to be deployed. |
yarn preview |
It boots up a local static web server that serves the files from views. |
gulp rtl |
This would compile plugin, scss and generates rtl css in public folder. |
gulp rtlBuild |
It compiles the assets including scss and bundles into production ready use RTL. |
npm comes preinstalled when you install Nodejs
| Command | Description |
|---|---|
npm i or npm i --force |
This would install all required dependencies node_modules folder.. |
gulp |
This would compile all the resources from assets folder to
public
folder.
|
npm run dev |
Runs the project locally, starts the node development server. |
gulp build |
It bundles with production mode. Your app is now ready to be deployed. |
npm run preview |
It boots up a local static web server that serves the files from views. |
gulp rtl |
This would compile plugin, scss and generates rtl css in public folder. |
gulp rtlBuild |
It compiles the assets including scss and bundles into production ready use RTL. |