githubEdit

Install from GitHub

How to install

circle-info

Opt for direct GitHub installation if you're planning to build customizations or want full source control of your theme code.

circle-info

Install these tools before you start:

1

Fork or clone the repository

After purchasing the theme you'll have GitHub access, clone the repo directly:

git clone https://github.com/BrickspaceLab/slab.git
cd slab

To maintain your own copy with the ability to pull upstream updates, fork the repo first on GitHub, then clone your fork:

git clone https://github.com/YOUR_USERNAME/slab.git
cd slab
git remote add upstream https://github.com/BrickspaceLab/slab.git
2

Install dependencies

npm install
3

Configure environment variables

Copy the example env file and fill in your values:

cp .env.example .env
Variable
Required
Description

STORE_PASSWORD

Optional

Storefront password, if your store has one enabled

4

Point to your store

Slab licenses are per-store — one license covers one storefront. Work directly against the store where the theme will be published. There is no need for a separate development store.

Open package.json and update the config.store field:

"config": {
  "store": "your-store.myshopify.com"
}

Then authenticate Shopify CLI with that store:

shopify auth login --store your-store.myshopify.com
5

Activate your license

When the theme loads in your store for the first time, it will prompt you to enter your license key. Enter the key from your order confirmation or customer portal. This activates and assigns the license to this store.

6

Start local development

npm run dev

This runs three parallel processes:

  • Vite dev server — compiles and hot-reloads CSS and JavaScript

  • Shopify theme dev — pushes your local files to an unpublished development preview on your store, served at http://127.0.0.1:9292

  • Section watcher — compiles src/sections/ preset JSON files into sections/

Your live store is unaffected while you work — shopify theme dev creates a separate unpublished copy of the theme. Publish it through the Shopify admin when you are ready to go live.

The Vite dev server shows an informational page at its own port — this is expected. The actual theme preview is at http://127.0.0.1:9292 via Shopify CLI.

Last updated

Was this helpful?