Getting Started

Project Preparation

Our project utilizes gulp for complete build flow automation. Several tools must be installed in your work environment.

Check for node, npm, and npx:

Ensure Node.js is installed on your computer by using the CLI:

node --version

npm --version

npx --version

We recommend using Node.js version 16 or higher. If not installed, follow these installation instructions.


Check for Gulp CLI Utility:

Confirm Gulp is installed on your computer:

gulp --version

If not installed, run:

npm install --global gulp-cli

Gulp is essential for automatically compiling SCSS files to .css and twig templates to .html. Learn more about it here.


Check for Sass Compiler:

Verify Sass compiler installation:

sass --version

If absent, install with:

npm install -g sass

Installing Required Dependencies

The package.json file lists necessary dependencies.

Navigate to Entrada's project directory:

cd entrada/project/directory-name

Install dependencies:

npm install

This installs all dependencies in the node_modules folder.

Running Gulp Automation

The gulpfile.js contains functions registered in gulp's task system.

To run project automation, execute:

gulp

This compiles assets and HTML files, starts the development server, and watches for code changes (including twig, JavaScript, sass, etc.).
The server is at http://localhost:3000 (port may vary).

SCSS:
We recommend making changes in /src/scss/custom.scss rather than overwriting any theme's custom SCSS files. This ensures safer updates without affecting your SCSS modifications.