Svelte Commerce × Sylius
Svelte Commerce on Sylius
Solid core coverage: cart, checkout and sign-in are wired against Sylius’s shop API. Sylius picks the channel from the request’s host, so the URL you give the connector decides which channel the storefront sells from.
- 24/43 services wired
- @misiki/sylius-connector 0.4.0
- Cart wired
- Checkout wired
- Sign-in (auth) wired
What works on Sylius today
Cart, checkout and sign-in are wired; wishlist, vendors and CMS pages are not.
Cart
Wired: issues a real request to Sylius.
Checkout
Wired: issues a real request to Sylius.
Sign-in (auth)
Wired: issues a real request to Sylius.
Known gaps: wishlist, vendor, page — each is explained under Limitations below.
24 of 43 services wired, read from CONNECTORS.md on , where the package version is recorded too; npm may carry a newer patch. Coverage is traced by a script in the Svelte Commerce repository: a service counts as wired only if it transitively issues an HTTP request, or delegates to one that does. It is not hand-asserted. Some services are Litekart-native concepts with no equivalent elsewhere (reels, deals, chat, gallery, popularity, demo-request, feedback, plugins, banner). They stay documented placeholders on every connector and are excluded from known gaps.
Quick start
From nothing to a Svelte Commerce storefront reading Sylius. You need Node.js and a Sylius to point it at; the storefront holds no data of its own.
Clone it, choose the connector, point it at Sylius
# 1 — get the storefront
git clone https://github.com/itswadesh/svelte-commerce
cd svelte-commerce
# 2 — one connector at a time: remove the two the storefront ships with, add this one
npm uninstall @misiki/litekart-connector @misiki/vendure-connector
npm i @misiki/sylius-connector
# 3 — point it at your Sylius channel
echo PUBLIC_SYLIUS_API_URL=https://your-store.example.com >> .env
# 4 — run it
npm run dev The guide removes only @misiki/litekart-connector. A fresh clone’s package.json also lists @misiki/vendure-connector, and with two connectors installed and neither of them Litekart’s, the build stops and asks for PUBLIC_CONNECTOR — so this removes both.
Environment variables
| Variable | Required | What it does |
|---|---|---|
PUBLIC_SYLIUS_API_URL | Yes | Your Sylius URL. Sylius picks the channel from this URL’s host — there is no channel header or parameter. Boot fails, naming this variable, if it is missing. |
PUBLIC_SYLIUS_LOCALE_CODE | No | Such as de_DE, sent as Accept-Language. Sylius falls back to the channel’s default locale. |
PUBLIC_SYLIUS_STORE_ID | No | Treated as the channel code, and used only to read that channel’s details. |
PUBLIC_SYLIUS_ACCESS_TOKEN | No | Sent as a bearer token when set. |
PUBLIC_CONNECTOR | No | Only when more than one connector is installed: @misiki/sylius-connector names the one this build runs on. |
init.ts hands the connector every PUBLIC_SYLIUS_* variable that is set, camel-cased. The guide also lists PUBLIC_SYLIUS_CHANNEL_ID, which cannot work against a stock install — the channel comes from the host — and PUBLIC_SYLIUS_API_KEY, PUBLIC_SYLIUS_API_SECRET and PUBLIC_SYLIUS_ACCESS_KEY, which the connector’s source does not read.
Every variable here begins PUBLIC_, and SvelteKit sends PUBLIC_ variables to the browser: treat each value you set as published.
What to set up on Sylius
- Point
PUBLIC_SYLIUS_API_URLat the hostname of the channel you want to sell from: Sylius resolves the channel from the request’s host. - Let the storefront’s origin make cross-origin requests to Sylius (CORS): in production the browser calls
PUBLIC_SYLIUS_API_URLdirectly, not only the server.
How the integration works
The connector speaks Sylius’s shop API. The channel is whichever one Sylius matches to the host of PUBLIC_SYLIUS_API_URL; the locale travels as Accept-Language. The API documentation URL its authors were given was dead, so it was written from Sylius’s own source instead.
Installing the package is the whole switch. vite.config.ts resolves whichever @misiki/*-connector is installed, and src/lib/core/connectors/init.ts hands it every PUBLIC_SYLIUS_* variable that is set, camel-cased, at boot — in the server hook for server rendering and in the client hook for the browser, which must reach the same URL in production.
There is no Litekart API behind the storefront here, so store identity — name, logo, currency, menus, plugin toggles, theme colours — comes from src/lib/core/connectors/default-store.json merged under the default export of kitcommerce.config.ts. Until you override it, the store is called “Test”. Any Litekart REST path the connector still inherits is answered from that local data, or resolved empty, rather than requested.
Limitations
- Wishlist: not wired.
- Vendors: not wired.
- CMS pages: not wired — legal and CMS pages render their layout with empty content.
- Pages that depend on a service that is not wired render their empty state rather than failing.
- Homepage sections other than the live product list come from the active theme’s static content — the standing rule for themes.
- The Conversational Shopping assistant is Litekart-only; its widget stays hidden when another connector is active.
Troubleshooting
| When you see | What to do |
|---|---|
| Boot fails with “the sylius connector is active but PUBLIC_SYLIUS_API_URL is not set” | Add PUBLIC_SYLIUS_API_URL to .env. A production Node build and Docker read PUBLIC_* from the process environment rather than .env, so set it on your deploy platform too. |
| The build stops with “Several commerce connectors are installed … Set PUBLIC_CONNECTOR to pick one” | More than one @misiki/*-connector is in package.json and none is Litekart’s. Uninstall the ones you do not run — a fresh clone also lists @misiki/vendure-connector — or set PUBLIC_CONNECTOR='@misiki/sylius-connector'. |
| Boot fails with “PUBLIC_…_API_URL is set, but it configures a different backend than the one this build runs on” | Another backend’s variable is still set, usually left over from the one you switched from. Remove it, or install that backend’s connector. PUBLIC_LITEKART_API_URL is exempt: it only points the dev proxy. |
| The store is called “Test”, or shows the wrong name and logo | Store identity is static on this backend. Set name, logo, currencyCode and the rest in the default export of kitcommerce.config.ts; src/lib/core/connectors/default-store.json lists every field. |
[sylius] no native implementation for get /api/... in the console | The connector’s REST guard caught a path inherited from Litekart and answered it empty instead of requesting it. Each path is reported once. Harmless if Sylius has no such feature; if it has one, the fix belongs in the connector’s matching service. |
http proxy error: api/... ECONNREFUSED in dev | A Litekart REST path was requested from outside the connector, so its guard never saw it. Vite proxies /api to PUBLIC_LITEKART_API_URL, or to localhost:7000. |
The build fails on @misiki/litekart-connector | @misiki/kitcommerce-core declares it as a peer, and vite.config.ts redirects that specifier to whichever connector is installed. Make sure exactly one @misiki/*-connector is listed in package.json. |
Before you rely on it
The one caveat that matters
Read this before choosing
Every connector was written by reading its platform’s authoritative source — an OpenAPI spec, a RAML file, a router registration or the controller source — rather than by running against a store. No connector has been exercised against a live production instance of its platform.
Offer a sandbox or a correctionFAQ
Questions about Svelte Commerce on Sylius
Can I run a Sylius store on Svelte Commerce today?
Cart, checkout and sign-in are wired; wishlist, vendors and CMS pages are not. Like every connector, it has not been run against a live production Sylius store.
How do I switch Svelte Commerce to Sylius?
Remove the connectors the storefront ships with, install @misiki/sylius-connector, set PUBLIC_SYLIUS_API_URL in .env and start the dev server. vite.config.ts resolves whichever connector is installed, so no file in the storefront changes.
How does Svelte Commerce pick a Sylius channel?
By host. Sylius resolves the channel from the host of the request, so point PUBLIC_SYLIUS_API_URL at the channel’s hostname. There is no channel header or parameter to set instead.
Has the Sylius connector been run against a real Sylius store?
Not against a live production instance — no Svelte Commerce connector has been. It was written by reading Sylius’s authoritative API source, and the Svelte Commerce maintainers ask Sylius’s own maintainers for a sandbox to run it against.
Sources
This page summarises SYLIUS.md in the Svelte Commerce repository and the Sylius connector’s source, read on , and the coverage in CONNECTORS.md, read on . Where they disagree with this page, they are right and this page is out of date. Sylius is a trademark of its owner, named here only to describe compatibility; no endorsement or affiliation is implied — see trademarks.
Read the whole guide
The storefront is the same on every backend; the connector is what changes. SYLIUS.md has the Sylius setup in full, beside the connector’s source.