README - Local Setup for BigCommerce Stencil Development (Windows 11)

✅ Prerequisites:

• Node.js LTS (recommended: v20.x) installed via nvm-windows
• Git installed (Download)
• Python 3.x (Download)
• Windows Terminal or VS Code integrated terminal.

🚀 Installation Steps:

1. Install Node.js with NVM (recommended):

nvm install 20.12.1
nvm use 20.12.1

2. Install Windows Build Tools (required for native Node modules):

• Open PowerShell (Admin):

npm install -g windows-build-tools

3. Install Stencil CLI globally:

npm install -g @bigcommerce/stencil-cli

4. Clone your BigCommerce Theme Repository:

git clone https://github.com/your-repo/theme-name.git
cd theme-name

5. Install theme dependencies:

npm install

6. Prepare your Stencil Theme:

• Create a .stencil file in the root of your theme:

{
    "accessToken": "your_api_token",
    "normalStoreUrl": "https://your-store.mybigcommerce.com",
    "port": 3000
}

(Replace placeholders with your BigCommerce store URL and API token.)

⚙️ Running Stencil Locally:

• Launch theme preview:

stencil start

• Access your local theme at:

http://localhost:3000

🔍 Testing and Optimizations:

• Run Lighthouse performance tests directly from Chrome Developer Tools on your local instance.
• Integrate Stylelint, ESLint, and Prettier in VS Code for clean code formatting and linting.