Flow State Flow State

Working locally

Boilerplate

Boilerplate is a “starter” repository that you can clone and use to get your project off the ground quickly using Squiz approved tooling.

How to install

To get started with Boilerplate you’ll need to clone the repo:

git clone git@gitlab.squiz.net:boilerplate/webpack-boilerplate.git

The navigate inside the project

cd webpack-boilerplate/

Remove link to repo and re-initialise the boilerplate:

rm -R .git
git init

Install dependencies

npm i

Run locally

npm run serve

For more in depth look check out the installation guide in the README

What’s in the box?

Boilerplate comes with some great tools to help you build your project.

Webpack Webpack

At its core, webpack is a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph from one or more entry points and then combines every module your project needs into one or more bundles, which are static assets to serve your content from.

Check out the docs for more info

ESLint ESLint

ESLint is a configurable JavaScript linter. It helps you find and fix problems in your JavaScript code. Problems can be anything from potential runtime bugs, to not following best practices, to styling issues.

Check out the docs for more info

Stylelint Stylelint

Packed with features, Stylelint is a mighty, modern CSS linter that helps you enforce consistent conventions and avoid errors in your stylesheets.

Check out the docs for more info

Volta Volta

To make sure you and your team are running always the same version of Node and NPM set the version in the projects package.json

"volta": {
  "node": "18.15.0"
}

If you don’t already have Volta installed globally you’ll need to do that:

# install Volta
curl https://get.volta.sh | bash

# install Node
volta install node

See the Volta docs

See IDE setup, when using StarterKit in conjunction with the recommended IDE plugins you’ll be unstoppable.

See, How we work to better understand the big picture. [accelerator