Svelte Commerce × Django Oscar
Svelte Commerce on Django Oscar
The Django Oscar connector is wired against django-oscar-api, a separate package from Oscar core that must be installed and routed on your instance. Cart, checkout and sign-in are wired; search is among nine recorded gaps.
- 15/43 services wired
- @misiki/oscar-connector 0.5.0
- Cart wired
- Checkout wired
- Sign-in (auth) wired
What works on Django Oscar today
Cart, checkout and sign-in are wired; coupons, reviews, search, CMS pages, payment-method listing, currencies, states, wishlist and vendors are not. Without search, shoppers find products only by browsing.
Cart
Wired: issues a real request to Django Oscar.
Checkout
Wired: issues a real request to Django Oscar.
Sign-in (auth)
Wired: issues a real request to Django Oscar.
Known gaps: coupon, review, search, page, payment-method, currency, state, wishlist, vendor — each is explained under Limitations below.
15 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 Django Oscar. You need Node.js and a Django Oscar to point it at; the storefront holds no data of its own.
Clone it, choose the connector, point it at Django Oscar
# 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/oscar-connector
# 3 — point it at your Oscar site
echo PUBLIC_DJANGO_OSCAR_API_URL=https://your-store.example.com >> .env
# 4 — run it
npm run devThe 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_DJANGO_OSCAR_API_URL | Yes | Base URL of your Oscar site, with django-oscar-api routed. Boot fails, naming this variable, if it is missing. |
PUBLIC_DJANGO_OSCAR_API_KEY | No | HTTP Basic username, for stores that authenticate that way. By default the connector uses django-oscar-api’s Session-Id header session. See the limitations. |
PUBLIC_DJANGO_OSCAR_API_SECRET | No | HTTP Basic password, with the username above. |
PUBLIC_DJANGO_OSCAR_ACCESS_TOKEN | No | Sent as Authorization: Token <key> — only useful if your store wired up DRF token authentication itself; django-oscar-api does not ship it. |
PUBLIC_CONNECTOR | No | Only when more than one connector is installed: @misiki/oscar-connector names the one this build runs on. |
The package is oscar-connector, but the variables follow the product: PUBLIC_DJANGO_OSCAR_*. init.ts hands the connector every one that is set, camel-cased. The guide also lists PUBLIC_DJANGO_OSCAR_ACCESS_KEY, PUBLIC_DJANGO_OSCAR_STORE_ID and PUBLIC_DJANGO_OSCAR_CHANNEL_ID; the connector’s source does not read them.
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 Django Oscar
- Install django-oscar-api and route it on your instance: it is a separate package from Oscar core, and the connector talks to nothing else.
- Let the storefront’s origin make cross-origin requests to Django Oscar (CORS): in production the browser calls
PUBLIC_DJANGO_OSCAR_API_URLdirectly, not only the server.
How the integration works
The connector speaks django-oscar-api, not Oscar core. By default it keeps the shopper’s session in django-oscar-api’s Session-Id header, which needs no CSRF token; HTTP Basic works too, and there is no bearer scheme at all — django-oscar-api ignores Authorization: Bearer. The route documentation its authors were given was dead, so it was written from the package’s source.
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_DJANGO_OSCAR_* 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
- Coupons: not wired.
- Reviews: not wired.
- Search: not wired.
- CMS pages: not wired — legal and CMS pages render their layout with empty content.
- Payment-method listing: not wired.
- Currencies: not wired.
- States and regions: not wired.
- Wishlist: not wired.
- Vendors: not wired.
- Pages that depend on a service that is not wired render their empty state rather than failing.
- If you set
PUBLIC_DJANGO_OSCAR_API_KEYandPUBLIC_DJANGO_OSCAR_API_SECRETfor HTTP Basic, that username and password reach every visitor: SvelteKit sendsPUBLIC_variables to the browser. - 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 oscar connector is active but PUBLIC_DJANGO_OSCAR_API_URL is not set” | Add PUBLIC_DJANGO_OSCAR_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/oscar-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. |
[oscar] 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 Django Oscar 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.
An open question for Django Oscar’s maintainers: Is a headless storefront a supported use case for django-oscar-api? Worth stating either way in its docs.
Offer a sandbox or a correctionFAQ
Questions about Svelte Commerce on Django Oscar
Can I run a Django Oscar store on Svelte Commerce today?
Cart, checkout and sign-in are wired through django-oscar-api. Nine services are not, search among them. Like every connector, it has not been run against a live production Oscar store.
How do I switch Svelte Commerce to Django Oscar?
Remove the connectors the storefront ships with, install @misiki/oscar-connector, set PUBLIC_DJANGO_OSCAR_API_URL in .env and start the dev server. vite.config.ts resolves whichever connector is installed, so no file in the storefront changes.
Does Django Oscar need anything extra installed?
Yes: django-oscar-api, a separate package from Oscar core, installed and routed on your instance. The connector talks to it and to nothing else.
Has the Django Oscar connector been run against a real Django Oscar store?
Not against a live production instance — no Svelte Commerce connector has been. It was written by reading Django Oscar’s authoritative API source, and the Svelte Commerce maintainers ask Django Oscar’s own maintainers for a sandbox to run it against.
Sources
This page summarises DJANGO-OSCAR.md in the Svelte Commerce repository and the Django Oscar 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. Django Oscar 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. DJANGO-OSCAR.md has the Django Oscar setup in full, beside the connector’s source.