Install from GitHub

How to install

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

Install these tools before you start:

• Node.js (18+)

• npm

• Shopify CLI (3+)

1

Fork the repository

After purchasing the theme, you'll have GitHub access. On GitHub, fork BrickspaceLab/slab to your account. Then clone your fork (not the upstream repo directly) and add the original repo as upstream so you can merge new releases later—see Pull upstream updates.

git clone https://github.com/<your-github-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

Set STORE_DOMAIN to your development store domain:

STORE_DOMAIN=your-store.myshopify.com

Optional values:

• Add STORE_PASSWORD if the storefront is password-protected.

• Add SHOPIFY_CLI_THEME_TOKEN if you want Shopify CLI to authenticate without prompting.

• Add CORS_ORIGINS if you preview the theme on a custom domain.

4

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.

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

Optional: add repo secrets for GitHub Actions

Preview deploys use STORE_DOMAIN and SHOPIFY_CLI_THEME_TOKEN.

Other CI workflows may also need secrets such as CURSOR_API_KEY.