shopify-boilerplate

A starter kit for Shopify theme development.

Features

• Type checking with TypeScript
• Bundle TypeScript files using Babel
• Transpile CSS files using PostCSS
• Lint and format files with ESLint, Stylelint and Prettier
• Use Lefthook to run linters on Git staged files
• Run linters on pull request using GitHub Actions

Requirements

• Volta

How to use

Clone this repository and install the dependencies:

npm i

Rename the .env.example file to .env, and replace YOUR_STORE_NAME with your actual store name:

SHOPIFY_FLAG_STORE=YOUR_STORE_NAME

This repository does not include any Shopify themes. You will need to add the theme files yourself. If you are creating a new theme, it is recommended to use Dawn as a starting point.

Available Commands

Start Development

npm start

Build Scripts and Styles

npm run build

Lint Files

npm run lint

Fix Files

npm run fix

Recommended IDE

Visual Studio Code