• Stars
    star
    100
  • Rank 340,703 (Top 7 %)
  • Language
    JavaScript
  • License
    BSD 4-Clause "Ori...
  • Created over 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

BigCommerce Stencil emulator for local theme development

Stencil CLI

npm (scoped) tests

The BigCommerce server emulator for local theme development.

Install

Note: Stencil requires the Node.js runtime environment, versions 16.x, 18.x are supported.

Run npm install -g @bigcommerce/stencil-cli.

Visit the installation guide for more details.

Usage

Usage: stencil [options] [command]

Commands:

  init        Interactively create a .stencil file which configures how to run a BigCommerce store locally.
  start       Starts up the BigCommerce storefront local development environment, using theme files in the current directory and data from the live store.
  bundle      Bundles up the theme into a zip file which can be uploaded to BigCommerce.
  release     Create a new release in the theme's github repository.
  push        Bundles up the theme into a zip file and uploads it to your store.
  pull        Pulls the configuration from the active theme on your live store and updates your local configuration.
  download    Downloads the theme files from the active theme on your live store.
  debug       Prints environment and theme settings for debug purposes.
  help [cmd]  display help for [cmd]

Options:

  -h, --help     output usage information
  -V, --version  output the version number

Run stencil init at the top level of your Stencil Theme. It will ask you a few questions to get your started.

Run stencil start to run a local server so you can start developing your theme.

Run with -o or --open to automatically open up a browser.

  • While stencil is running, you can type "rs" and then hit enter to auto-reload all browsers. This is similar to Nodemon's rs option.

Run stencil bundle to validate your code and create a zip bundle file that can be uploaded to BigCommerce.

Run stencil release to tag a new version of your theme, create a GitHub release in your theme repository, and upload the zip bundle file to the release assets. This is useful for tracking your changes in your Theme, and is the tool we use to create new releases in BigCommerce Cornerstone theme.

Run stencil push to bundle the local theme and upload it to your store, so it will be available in My Themes. To push the theme and also activate it, use stencil push -a. To automatically delete the oldest theme if you are at your theme limit, use stencil push -d. These can be used together, as stencil push -a -d. You can apply the theme to multiple storefronts, just specify ids of desired storefronts/channels after -c option stencil push -a -c 123 456 789. If you want to apply theme to all available storefronts, just use -allc option: stencil push -a -allc.

Run stencil pull to sync changes to your theme configuration from your live store. For example, if Page Builder has been used to change certain theme settings, this will update those settings in config.json in your theme files so you don't overwrite them on your next upload.

Run stencil debug to get information about runtime environment and the configuration

Features

BrowserSync

Stencil CLI comes packaged with BrowserSync so you can take advantage of all of those amazing goodies! Have a look at their web site for more information.

Sass compiling

You can compile Sass (node-sass) scss files in assets/scss into CSS. For example, add an scss file named theme.scss to assets/scss and {{{stylesheet 'assets/css/theme.css'}}} to your theme HTML template. Stencil-CLI will compile assets/scss/theme.scss to CSS on the fly.

Autoprefixer

Stencil CLI comes packaged with Autoprefixer. You can set which browsers should be targeted, as well as if it should cascade the generated rules in the theme's config.json file with these options:

  • autoprefixer_cascade - Defaults to true.
  • autoprefixer_browsers - Defaults to ["> 1%", "last 2 versions", "Firefox ESR"].

How to get help or report a bug

If you need any help or experience any bugs, please create a GitHub issue in this repository.

Development

If you would like to improve this project check out the Contributing Guide. Also, you can find the implementation details there.

Running in docker

There is possibility to run stencil-cli in docker. Here are steps to have this functionality.

First, pull the image from Github Packages (docker registry): docker pull ghcr.io/bigcommerce/stencil-cli

Then, you want to run some commands against your theme.

For example docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it ghcr.io/bigcommerce/stencil-cli stencil init, where 3005 is port number definded in config.stencil.json and /bigcommerce/cornerstone path to where theme is located.

docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it ghcr.io/bigcommerce/stencil-cli stencil start and so on

License

Copyright (c) 2015-present, BigCommerce Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by BigCommerce Inc.
  4. Neither the name of BigCommerce Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY BIGCOMMERCE INC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BIGCOMMERCE INC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

More Repositories

1

gruf

gRPC Ruby Framework
Ruby
561
star
2

cornerstone

The BigCommerce Cornerstone theme
HTML
282
star
3

sass-style-guide

Sass coding guidelines for BigCommerce themes
CSS
280
star
4

storefront-data-hooks

Hooks for React Storefront UI Components
TypeScript
166
star
5

bigcommerce-api-php

Connect PHP applications with the Bigcommerce Platform
PHP
143
star
6

checkout-sdk-js

BigCommerce Checkout JavaScript SDK
TypeScript
121
star
7

gatsby-bigcommerce-netlify-cms-starter

Example Gatsby, BigCommerce and Netlify CMS project meant to jump start JAMStack ecommerce sites.
CSS
118
star
8

bigcommerce-for-wordpress

A headless commerce integration for WordPress, powered by BigCommerce
PHP
106
star
9

checkout-js

Optimized One-Page Checkout
TypeScript
102
star
10

catalyst

Catalyst - for Composable Commerce
TypeScript
100
star
11

bigcommerce-api-python

Python client library for Bigcommerce API
Python
83
star
12

bigcommerce-api-ruby

Connect Ruby applications with the Bigcommerce Platform
Ruby
77
star
13

laravel-react-sample-app

Sample BigCommerce App Using Laravel and React
PHP
69
star
14

gruf-demo

A demonstration Rails application utilizing gruf, a gRPC Rails framework.
Ruby
57
star
15

bc-nuxt-vue-starter

A starter site for Vue + Nuxt based storefronts that uses Divante's Storefront UI and BC's GraphQL API
Vue
51
star
16

sample-app-nodejs

A reference implementation of a BigCommerce single-click app, in Node.JS + Next.js/React
TypeScript
43
star
17

big-design

Design system that powers the BigCommerce ecosystem.
TypeScript
42
star
18

dev-docs

This repo contains the markdown files and static assets powering developer.bigcommerce.com. https://developer.bigcommerce.com/
41
star
19

api-specs

OpenAPI Specifications, Swagger, and JSON schema used to generate the human-readable BigCommerce API Reference.
Python
34
star
20

stencil-utils

Utility library for the Stencil theme framework.
JavaScript
33
star
21

hello-world-app-python-flask

Hello World sample app in Python and Flask
Python
31
star
22

b2b-buyer-portal

B2B Buyer Portal - BigCommerce B2B Edition
TypeScript
25
star
23

grphp

PHP gRPC Framework
PHP
24
star
24

hello-world-app-php-silex

Hello World sample app in PHP and Silex
PHP
23
star
25

gruf-rspec

RSpec helper suite for gruf
Ruby
20
star
26

script-loader-js

A library for loading JavaScript files asynchronously
TypeScript
17
star
27

channels-app

TypeScript
13
star
28

omniauth-bigcommerce

OmniAuth Bigcommerce Strategy
Ruby
13
star
29

storefront-api-examples

Example of using the GraphQL Storefront API to power a static site using Bootstrap and VanillaJS
HTML
12
star
30

paper

Paper assembles templates and translations and renders pages using backend template engines
JavaScript
11
star
31

subscription-foundation

Foundation for building custom subscription applications w/ BigCommerce
TypeScript
11
star
32

net-http

A basic HTTP client.
PHP
11
star
33

ai-app-foundation

TypeScript
10
star
34

widget-builder

TypeScript
10
star
35

hello-world-app-ruby-sinatra

Hello World sample app with Ruby, Sinatra and DataMapper
Ruby
10
star
36

paper-handlebars

Paper plugin for rendering via Handlebars.js
JavaScript
9
star
37

docs

The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX
MDX
9
star
38

gruf-circuit-breaker

Circuit breaker support for gruf
Ruby
8
star
39

bigcommerce-api-node

A node module for authentication and communication with the BigCommerce API
TypeScript
7
star
40

gruf-newrelic

New Relic tracing for gruf services
Ruby
7
star
41

point-of-sale-foundation

Foundation for building custom POS applications w/ BigCommerce
TypeScript
7
star
42

gruf-prometheus

Gruf plugin for Prometheus support
Ruby
5
star
43

gruf-profiler

Profiler for gruf-backed gRPC requests
Ruby
5
star
44

gruf-zipkin

Zipkin tracing plugin for Gruf
Ruby
5
star
45

gruf-commander

Command/Request library for Gruf request validation
Ruby
5
star
46

php-resque-pause

An addon for php-resque, php-resque-pause adds functionality to pause resque jobs.
PHP
5
star
47

data-store-js

A JavaScript library for managing application state
TypeScript
5
star
48

stencil-styles

Compiles SCSS for the Stencil Framework
HTML
5
star
49

form-poster-js

Post HTML form programmatically
TypeScript
5
star
50

netlify-nextjs-starter

TypeScript
4
star
51

mock-injector

Auto-mocking dependencies for DI components testing.
PHP
4
star
52

theme-context-object-schemas

JSON schema used to generate the human-readable BigCommerce Handlebars Reference.
4
star
53

gruf-lightstep

LightStep tracing for gruf
Ruby
4
star
54

validate-commits

Commit message validator
JavaScript
4
star
55

gruf-sentry

Sentry integration for gruf
Ruby
3
star
56

request-sender-js

HTTP request client for browsers
TypeScript
3
star
57

memoize-js

A JavaScript library for memoizing the result of a pure function
TypeScript
3
star
58

stencil-lang-validator

Validate language keys used in templates and scripts
JavaScript
3
star
59

statsd-client

Record timing, increment, and count metrics in StatsD
PHP
3
star
60

injector

Dependency Injector component built on top of Pimple container.
PHP
3
star
61

eslint-config

JavaScript
3
star
62

bigpay-client-js

Bigpay client-side library
JavaScript
3
star
63

stand-with-ukraine-backend

Stand With Ukraine is a BigCommerce application. It allows merchants to easily add a widget to their storefront with a customized message and list of Charities that the merchant would like their shoppers to visit and support.
Rust
2
star
64

bc-lightstep-ruby

Generic lightstep library for distributed tracing in ruby
Ruby
2
star
65

sample-shipping-provider

Silex based reference implementation of a Shipping Carrier Service integration
PHP
2
star
66

nomad-workload-cpu-actuals-report-generator

Groovy
2
star
67

grphp-statsd

StatsD interceptor for measuring grphp client requests.
PHP
2
star
68

tslint-config

Default TSLint configuration used at BigCommerce
2
star
69

noopraven-go

A raven-go interface with a noop implementation.
Go
2
star
70

ruby-rails-react-sample-app

BigCommerce App - Ruby on Rails + React + BigDesign
Ruby
2
star
71

nextjs-contentstack-starter

TypeScript
2
star
72

stand-with-ukraine-frontend

Stand With Ukraine is a BigCommerce application. It allows merchants to easily add a widget to their storefront with a customized message and list of Charities that the merchant would like their shoppers to visit and support.
TypeScript
2
star
73

threatDragon

This repo is for storing threat modelling of BigCommerce projects
1
star
74

gruf-balancer

Percentage-based balancing of gruf-client requests for testing
Ruby
1
star
75

bonvoy

Go utility CLI tool for Envoy and Consul Connect
Go
1
star
76

themes-lib-scroll-link

JavaScript
1
star
77

app-sdk-js

JavaScript
1
star
78

puppet-module-supervisor

Puppet module for configuring the supervisor daemon control utility
Ruby
1
star
79

themes-lib-compare

JavaScript
1
star
80

themes-lib-squid

JavaScript
1
star
81

drupal-module-clientside_validation

Fork of the Drupal clientside_validation module to fix an upstream Internet Explorer bug - http://drupal.org/node/1995314
1
star
82

data-docker-debian-runfromenv

Basic Debian image to run a user-supplied script from the environment.
Shell
1
star
83

optimized-checkout-changelog

Summarises the changes made to the Optimized One Page Checkout Angular application.
1
star
84

themes-lib-loading

JavaScript
1
star
85

themes-lib-swipe-fade

JavaScript
1
star
86

bc-prometheus-ruby

Drop-in support for prometheus metrics for Ruby apps
Ruby
1
star
87

themes-lib-modal

JavaScript
1
star
88

axfr2tf

Converts an AXFR DNS query to Terraform resources
Rust
1
star