Getting started
The Template SDK is a complete, standalone kit for building templates for the storefront: a launcher, a CLI, a visual Studio, a preview with demo data, a validator built from the store's rules, a test runner, and packaging that produces folders the store installs as they are. It needs only Node.js — no store, no database, no npm packages.
7075c14c24bbaf06), built into the SDK on 2026-10-01. Statements about the template system cite the store's source as file:line — hover to see the line.Who does what
| Template developer | Store owner | |
|---|---|---|
| Has | this SDK and their template files | the store application |
| Does | creates, edits, previews, validates, tests and packages templates | installs the template packages developers send |
| Commands | the launcher, or create, dev, validate, test, package | verify --app, install --app, runtime update --app |
Requirements
- Node.js 18 or newer (Windows, macOS or Linux) from nodejs.org. Nothing else is installed: the SDK has no npm dependencies and carries the storefront preview and demo data itself.
- Optional: Chrome, Edge or Chromium for browser tests, screenshots and the Studio window (found automatically). Without one, the Studio opens in your default browser and tests run the file and rendering checks only.
- Internet access for the preview's jQuery, Bootstrap and Font Awesome files (the store loads them from CDNs). To work offline, run
node bin/template-sdk cdn fetchonce while online.
Start
Nothing is installed. Unzip the SDK, then:
- Windows: double-click
Start.cmd. macOS / Linux: run./start.sh(orsh start.sh). Any system:node startin the SDK folder. - The menu creates templates (in
projects/), opens them in the Studio, checks and packages them.
From a terminal instead: in the SDK folder use node bin/template-sdk <command>; inside a template folder use node sdk <command> (every template made by the SDK has a small sdk.js that finds the SDK). On Windows sdk <command> works too (.\sdk in PowerShell), and npm run dev / validate / test / package if npm is present.
For the store owner
node bin/template-sdk verify my-template-1.0.0.zip --app /path/to/frontend # check a package against the live store
node bin/template-sdk install my-template-1.0.0.zip --app /path/to/frontend # copy it into <frontend>/templates
node bin/template-sdk runtime update --app /path/to/frontend # after a store update: refresh the SDK's built-in rules and renderer
Your first template
# in the SDK folder
node bin/template-sdk create my-template # → projects/my-template ("storefront" starter: every engine feature wired)
node bin/template-sdk create my-blank --from blank # minimal starting point
node bin/template-sdk create my-copy --from organic # copy of one of the store's templates
cd projects/my-template
node sdk dev # Studio: visual + code editor with live preview (Ctrl+C to stop)
node sdk validate
node sdk test
node sdk package # dist/my-template-<version>.zip, verified → send it to the store owner
A template folder you already have: node bin/template-sdk import <folder or zip> (copies it into a project), or node bin/template-sdk init <folder> to add sdk.js to it in place.
Project layout
| Path | Part of the template? | Purpose |
|---|---|---|
index.html | yes | Markup rendered by the application (see HTML). |
styles.css / style.css | yes | Stylesheet (see CSS). |
script.js | yes | Theme script (see JavaScript). |
template.json | yes (required) | Configuration (see Configuration). |
theme.json | yes (optional) | Installation metadata. |
image/ | yes | Images served at /image/… (see Assets). |
template-sdk.json | no | SDK project settings (normally empty). |
sdk.js, sdk.cmd, package.json | no | Launchers: node sdk <command>, sdk <command> (Windows), npm run <command>. |
tests/ | no | Your tests (see Testing). |
sample-data/ | no | Your preview datasets (see Sample data). |
dist/ | no | Build output and packages. |
.template-sdk/ | no | Caches, the staged preview, test results. Safe to delete. |
Only the template files are copied into builds and packages; the others never reach the application.
Starters
- storefront — generated by the application's own template generator (
tools/templates/build.py) with every engine block wired: header, store chooser, home blocks, products, product detail, cart, checkout, account, legal pages. - blank — the smallest valid template: placeholders, a home section and the store blocks.
- any installed template —
--from <name>copies it from<app>/templates(15 installed:animal,beauty,boutique,corporate,couture,default,electro,farm,food,grocer,homeliving,love,organic,prestashop,store).