Build Boilerplate

1.3.8 verified Sat Apr 25 auth: no javascript maintenance

build-boiler is a build boilerplate tool (v5.2.4) integrating Webpack, Gulp, Eslint, Nunjucks, and BrowserSync for front-end development. It provides a configured environment with hot reload, CSS timestamping, and webpack md5 hashing. The package uses Gulp as its task runner and includes Assemble for templating. However, it is outdated, requires Node 5.x and npm@3, and the latest versions include security fixes for BrowserSync (disabling online mode by default). The project appears to be in maintenance mode with no recent active development.

Common errors

error Error: Cannot find module 'gulp' ↓

cause gulp not installed globally or locally.

fix

npm i -g gulp

error Error: The engine "node" is incompatible with this module. ↓

cause Node version is higher than 5.x.

fix

Use Node 5.x via nvm: nvm install 5 && nvm use 5

error ReferenceError: primordials is not defined ↓

cause Incompatible gulp version with Node >=12 due to graceful-fs dependency.

fix

Use Node 5 or downgrade to gulp 3.x; or use newer alternative.

error Error: Cannot find module 'webpack' ↓

cause Dependencies not installed.

fix

Run npm i and ensure npm@3 is used.

Warnings

breaking Requires Node 5.x (engines field). May not work with newer Node versions. ↓

fix Use Node 5.x. For newer Node, consider alternative modern tooling.

breaking Requires npm@3. npm@5+ may cause issues. ↓

fix Run `npm i -g npm@3` before installation.

breaking BrowserSync online mode enabled by default in versions before 3.5.2, 4.4.2, and 5.2.3; exposes panel to external network (security hijacking risk). ↓

fix Update to v3.5.2+, v4.4.2+, or v5.2.3+. To manually disable online mode, set `browserSync: { online: false }` in config.

deprecated Isomorphic webpack tools warning in v5.x before 5.2.1. ↓

fix Update to v5.2.1+.

gotcha npm install from private GitHub repos with branch specifier will fail in CI if repo is private. ↓

fix Use published npm packages or configure SSH keys for CI.

gotcha Gulp must be installed globally (`npm i -g gulp`). Local gulp may not work. ↓

fix Install gulp globally.

Install

npm install build-boiler

yarn add build-boiler

pnpm add build-boiler

Quickstart

Clone repository, install Node 5 and npm@3, install global Gulp and dependencies, then start watch task for live reload.

git clone https://github.com/dtothefp/build-boiler.git
cd build-boiler
# Install Node 5.x (required)
nvm install 5
npm i -g npm@3
npm i -g gulp
npm i
# Start development with hot reload
gulp watch