@wondercraft/create-wonderplate-shopify

Wonderplate Shopify CLI

A simple CLI tool to drop some very basic scaffolding for a shopify theme.

What do you get when you run the command:

• A basic Vite setup to bundle assets
• Tailwind CSS
• A set of scripts to create new components using plop

You do not get a full shopify theme, you will need to add the required files yourself. You can download Dawn from the shopify git page. or it can be provided by the client.

This CLI is heavily inspired by the create-t3-app project.

For more information check the documentation.

Usage

npm create @wondercraft/wonderplate-shopify@latest

Contribute

This is mainly a CLI project, which means the code for that is in the /src folder, then the /template folder is what is going to be "downloaded" or copied into the client machine when the cli runs.

So once you clone the repo and install the dependencies you can run npm run dev to build the cli.

Then, to test your work, create a new folder somewhere and run the cli from that folder with node /path/to/wonderplate-shopify/dist/index.js and it will create a new project in the folder you are in. TODO: look into how to make this easier with npm link.

How to add new dependencies

TODO: Explain how the /packageMappers folder works.

Checking dependency updates with Vscode's Version Lens

To help us keep dependencies up to date we like to use Version Lens in vscode. This will show you the latest version of a dependency in the package.json file.

But to work with the mapping files in the folder /packageMappers you have to update the settings following these steps:

1. Open the settings in vscode
2. Search for @ext:pflannery.vscode-versionlens npm
3. Change the Version Lens > Npm: Files value to **/package*.json

Documentation

We are using VitePress to generate the documentation site. You can find the docs in the /docs folder.