• Minimum requirements
• Getting started
  • Install NVM
  • Install Node
  • Install Gulp (CLI)
  • Install dependencies
  • Local development
  • Production

Minimum requirements

• NVM: 0.40.1
• Node: 23.4.0
• NPM: 10.9.2

Getting started

Install NVM

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Install Node

First, navigate to the repo's root directory.

cd path/to/repo

Then, install Node.

nvm install

Install Gulp (CLI)

$ npm install -g gulp-cli

Install dependencies

npm run setup

Note: npm run setup uses --ignore-scripts to protect against malicious postinstall lifecycle attacks, then selectively runs only approved scripts. See the Repository Security Audit for context on this work.

Local development

$ npm run start

• Builds the src files to the docs folder, launches a local Browsersync server in a browser, watches for file changes, and reloads the page when changes are detected.

Production

$ npm run build

• Initiates the build stream, without launching a local server in a browser.