BigCommerce Stencil CLI

Installation

Mac OS Prerequisites

Stencil requires the Node.js runtime environment, version 6.10.3 to 7.9.

?> We recommend that you install or update Node.js usingnvm

Next, explicitly install a supported Node.js version, using this convention:

nvm install 6.10.3

Installing the Stencil CLI.

npm install -g @bigcommerce/stencil-cli

Installing the Stencil Javascript

Complete the following steps:

Navigate to your Stencil theme directory. This example assumes that this target directory has the default name cornerstone.

cd cornerstone

Next, execute the following command inside of that directory:

npm install

This will install the required npm modules to properly leverage the Stencil event framework.

After initializing Stencil, issue the following command in your theme directory:

stencil start

When you navigate to your designated port (e.g http://localhost:3000), you should see the storefront you selected with the local Stencil theme applied.

{
  "normalStoreUrl": "https://store-6b668f.mybigcommerce.com/",
  "port": 3000,
  "username": "TrinityInsight",
  "token": "221b904ae4d98a8104fcd37520e5e8674f33af67",
  "customLayouts": {
    "brand": {},
    "category": {
      "category_explore.html": "/explore/"
    },
    "page": {
      "location.html": ["/locations/franklin-market/", "/locations/comcast-center/", "/locations/ardmore/", "/locations/rittenhouse-square/", "/locations/upstairs-at-rittenhouse-square/", "/locations/italian-market/"],
      "menu.html": "/locations/italian-market/italian-market-menus/",
      "page-no-bottom-banners.html": ["/locations/", "/menus/"]
    },
    "product": {
      "product-kilo-club.html": "/cheese-pairing-of-the-month/"
    }
  },
  "clientId": "",
  "accessToken": ""
}