Repository navigation
Configuration
The storefront is configured in three places: manifest.json describes your Layout for publishing, .env selects
the shop and defaults used during development, and the meta tags in index.html simulate the Selldone hosting
environment.
{
"deploy_server": "https://layouts.selldone.com",
"deploy_path": "",
"package": "sample-custom-storefront",
"name": "My Storefront",
"version": "0.0.22",
"storefront": true,
"backoffice": false,
"description": null
}| Field | Meaning |
|---|---|
package |
Unique id of your Layout. Pick your own (for example com.mybrand.storefront) before the first deploy. |
name |
Human-readable name shown in the developer panel. |
version |
Version of this build. Each deployment needs a new, unique version. |
storefront / backoffice
|
Where the Layout is used. This project is a storefront Layout. |
description |
Optional description of the Layout. |
deploy_server, deploy_path
|
Deployment target used by the tooling. Keep the defaults unless told otherwise. |
The Selldone CLI reads this file when it builds and uploads your Layout.
| Variable | Description | Example |
|---|---|---|
VITE_APP_SAMPLE_SHOP_NAME |
Shop whose live data is loaded during development. | toysworld |
VITE_APP_SAMPLE_SHOP_CUSTOM_HOME |
Home page: blog, avocado, hyper, community, shop, map, a landing page ID, or null. |
3001 |
VITE_APP_SAMPLE_DEFAULT_CURRENCY |
Default currency code. | GBP |
VITE_APP_SAMPLE_DEFAULT_COUNTRY |
Default country code. | GB |
VITE_APP_SAMPLE_DEFAULT_LANGUAGE |
Default language code. | en |
VITE_APP_SAMPLE_THEME_COLOR_LIGHT |
Primary (light) theme color. | "#70557E" |
VITE_APP_SAMPLE_THEME_COLOR_DARK |
Dark theme color. | "#000000" |
VITE_APP_SAMPLE_THEME_COLOR_DEEP_DARK |
Deep dark theme color. | "#000000" |
VITE_APP_SAMPLE_THEME_COLOR_INFO |
Accent (info) color. | "#E91E63" |
VITE_APP_DEV_SERVER_HOST |
Dev server host. | localhost |
VITE_APP_DEV_SERVER_PORT |
Dev server port. | 8080 |
VITE_APP_DEV_SERVER_HTTPS |
Serve over HTTPS (TRUE/FALSE). |
FALSE |
These values only affect development. In production, Selldone injects the real shop, defaults and theme of the shop that uses your Layout.
The storefront reads its runtime configuration from meta tags, exactly as it does when Selldone hosts it. In
development they are filled from .env.
Shop
<meta name="shop-name" content="%VITE_APP_SAMPLE_SHOP_NAME%"> <!-- the shop to load -->
<meta name="shop-prefix-address" content=""> <!-- path prefix, e.g. /my-shop-path -->
<meta name="custom-home" content="%VITE_APP_SAMPLE_SHOP_CUSTOM_HOME%">Business OS endpoints
<meta name="service-url" content="https://selldone.com">
<meta name="selldone-gapi" content="https://gapi.selldone.com"> <!-- general APIs -->
<meta name="selldone-xapi" content="https://xapi.selldone.com"> <!-- storefront (customer) APIs -->
<meta name="selldone-iframe" content="https://iframe.selldone.com">
<meta name="selldone-capi" content="https://capi.selldone.com"> <!-- community APIs -->CDNs and storage
<meta name="selldone-cdn-images" content="https://selldone.com/cdn-shop-images-1">
<meta name="selldone-cdn-jsons" content="https://selldone.com/cdn-shop-jsons-1">
<meta name="selldone-cdn-videos" content="https://selldone.com/cdn-videos">
<meta name="storage-redirect" content="true">
<meta name="storage-redirect-host" content="https://cdn.selldone.com">
<meta name="storage-redirect-thumbnails" content="true">Defaults and theme
<meta name="default-currency" content="%VITE_APP_SAMPLE_DEFAULT_CURRENCY%">
<meta name="color--theme-light" content="%VITE_APP_SAMPLE_THEME_COLOR_LIGHT%">The complete list with explanations is in INDEX.md. The same meta tags are used by the Storefront SDK when you build a storefront from scratch.
- Add
?native=trueto load the storefront in native-app mode. - Use
/login?app=<custom URI>to log in from a native app.
Get started
Develop and ship
Plan
Ecosystem
Links