create-wocart-theme
v0.2.1
Published
Create a Wocart storefront theme: an Astro project on @wocart/storefront and @wocart/theme, ready for Wocart Studio.
Maintainers
Readme
create-wocart-theme
Create a Wocart storefront theme: an Astro project that sells cash on
delivery in Algeria, in Arabic, French and English, on
@wocart/storefront and
@wocart/theme. It renders every page
a Wocart store has, takes orders (product form and basket, phone check,
codes, reviews), builds for both Cloudflare Workers and Vercel, and is ready
for Wocart Studio. Every theme it creates is whole, so Wocart Cloud can
deploy it on whichever host a merchant picks. It looks deliberately plain: the
brand lives in one file.
npm create wocart-theme@latest my-themeAlso pnpm create wocart-theme, yarn create wocart-theme or
bun create wocart-theme: the project installs with the manager you use.
Requirements
- Node.js 22.12 or newer.
- A Wocart store to read (its API address and a store API key) on platform v7.0.0 or newer.
Options
| Option | What it does |
| --- | --- |
| [dir] | Where the theme goes (asked when missing) |
| --name <name> | Package name; the directory's name by default |
| --key <key> | Theme key; from the name by default. Permanent once a store edits the theme: the platform keeps merchants' edits under it |
| --no-install | Write the files, install nothing |
| --git | Run git init in the project |
| --yes, -y | Ask nothing; take every default |
| --force | Write into a non-empty directory; an existing file is never overwritten |
| --template <name> | The template to start from (default) |
| --help, --version | |
The generator asks only in a terminal and never with --yes. Pass options
to npm create after --:
npm create wocart-theme@latest summer-shop -- --key summer-shop --yesWhat it does, and never does
It copies the template and stamps the project with its package name, theme
key, Worker name and README title. The wocart field in the new package.json records the template, this
generator's version and the platform the project needs.
It never deletes a file, never writes outside the new directory, never overwrites a file, reaches the network only through your package manager's install, and sends no telemetry.
Then
The new project's README.md and AGENTS.md explain everything else: the
first run, the variables, the project map, restyling, deploying to
Cloudflare Workers or Vercel, and how Studio support is checked locally.
License
Apache-2.0
