{"id":21826322,"url":"https://github.com/kazuki-tam/shopify-quick-theme-mix","last_synced_at":"2025-10-26T09:42:34.782Z","repository":{"id":61039556,"uuid":"532200922","full_name":"Kazuki-tam/shopify-quick-theme-mix","owner":"Kazuki-tam","description":"Starter kit which supports GitHub integration for Shopify theme developers.","archived":false,"fork":false,"pushed_at":"2024-08-21T03:51:45.000Z","size":138298,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T19:14:29.192Z","etag":null,"topics":["shopify","shopify-theme"],"latest_commit_sha":null,"homepage":"https://dev.to/tim_yone/starter-kit-for-shopify-theme-developers-5c5p","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kazuki-tam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-03T08:27:21.000Z","updated_at":"2025-02-07T11:36:27.000Z","dependencies_parsed_at":"2024-06-26T02:31:51.619Z","dependency_job_id":"1d7d85d6-6240-4d66-9c5e-36bf2316b30a","html_url":"https://github.com/Kazuki-tam/shopify-quick-theme-mix","commit_stats":null,"previous_names":[],"tags_count":9,"template":true,"template_full_name":"Kazuki-tam/shopify-quick-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kazuki-tam%2Fshopify-quick-theme-mix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kazuki-tam%2Fshopify-quick-theme-mix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kazuki-tam%2Fshopify-quick-theme-mix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kazuki-tam%2Fshopify-quick-theme-mix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kazuki-tam","download_url":"https://codeload.github.com/Kazuki-tam/shopify-quick-theme-mix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248825536,"owners_count":21167505,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shopify","shopify-theme"],"created_at":"2024-11-27T18:03:37.981Z","updated_at":"2025-10-26T09:42:34.775Z","avatar_url":"https://github.com/Kazuki-tam.png","language":"SCSS","funding_links":["https://buymeacoffee.com/ricebookspk"],"categories":[],"sub_categories":[],"readme":"# shopify-quick-theme-mix\n\nshopify-quick-theme-mix is a template extended from [shopify-quick-theme](https://github.com/Kazuki-tam/shopify-quick-theme).\n\nThis starter kit supports Shopify GitHub integration.\n\n[📖 Shopify GitHub integration](https://shopify.dev/themes/tools/github)\n## Status\n\n[![Release (latest by date)](https://img.shields.io/github/v/release/Kazuki-tam/shopify-quick-theme-mix)](https://github.com/Kazuki-tam/shopify-quick-theme-mix/releases/tag/v0.0.1)\n[![Issues](https://img.shields.io/github/issues/Kazuki-tam/shopify-quick-theme-mix)](https://github.com/Kazuki-tam/shopify-quick-theme-mix/issues)\n![Maintenance](https://img.shields.io/maintenance/yes/2025)\n![Release date](https://img.shields.io/github/release-date/Kazuki-tam/shopify-quick-theme-mix)\n\n## Features\n\n- Abstracting Shopify CLI command\n- Bundle TS files with Rspack\n- Transpile SCSS to CSS\n- Lint TS files with Biome\n- Built-in test runner with Vitest and Playwright\n\n## Requirements\n\n- [Node v22 or higher](https://nodejs.org/en/)\n- [Shopify CLI v3.78.2 or higher](https://shopify.dev/docs/api/shopify-cli/theme)\n\nNote: Please refer to [Install Shopify CLI](https://shopify.dev/docs/api/shopify-cli) if you haven't installed Shopify CLI yet.\n\n[📖 Upgrade or uninstall Shopify CLI](https://shopify.dev/docs/storefronts/themes/tools/cli#upgrade-shopify-cli)\n## Main dependencies\n\n- [Shopify CLI](https://shopify.dev/themes/tools/cli)\n- [pnpm](https://pnpm.io/)\n- [Rspack](https://www.rspack.dev/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [Sass](https://sass-lang.com/)\n- [Biome](https://biomejs.dev/)\n- [Vitest](https://vitest.dev/)\n- [Playwright](https://playwright.dev/)\n\n## How to use\n\nClone this repository and install dependencies.\n\n```bash\npnpm install\n```\n\nCreate a .env file at the root directory, and then add your SHOPIFY_FLAG_STORE value at least. Replace the placeholder YOUR_STORE_NAME with your actual store name.\n\n```\nSHOPIFY_FLAG_STORE=YOUR_STORE_NAME\n```\n\n### Create a new theme\n\nUse `newTheme` command to create a new theme from scratch. This command creates a copy of Dawn.\n\n```bash\npnpm newTheme\n```\n\n[📖 Theme commands - init](https://shopify.dev/themes/tools/cli/theme-commands#init)\n\n### Customize an existing theme\n\nUse `pull:new` command to customize an existing theme.\n\n```bash\npnpm pull:new\n```\n\n### Add CSS and JavaScript into your theme files\n\nAdd these tags in `\u003chead\u003e\u003c/head\u003e` section.\n\n```liquid\n{{ 'custom-style.css' | asset_url | stylesheet_tag }}\n```\n\n```liquid\n\u003cscript src=\"{{ 'custom-script.js' | asset_url }}\" defer\u003e\u003c/script\u003e\n```\n\n## Available Commands\n\nRecommend you to check out these commands before you get started.\n\n### Start command\n\nStart your project in development mode.\n\n```bash\npnpm dev\n```\n\n### Build command\n\nBuild your project for production.\n\n```bash\npnpm release\n```\n\nBuild your project for development.\n\n```bash\npnpm build\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOther support commands\u003c/summary\u003e\n\n### Pull command\n\nRetrieve theme files from Shopify without deleting local files.\n\n```bash\npnpm pull\n```\n\n### Push command\n\nUpload your local theme files to Shopify without deleting remote files.\n\n```bash\npnpm push\n```\n\nPush to your development theme. If you don't have a development theme, then one is created.\n\n```bash\npnpm push:dev\n```\n\nUpload the theme to the theme library as a new unpublished theme.\n\n```bash\npnpm push:upload\n```\n\n### Deploy command\n\nBuild your local files and upload them to Shopify as production.\n\n```bash\npnpm deploy\n```\n\nBuild your local files and upload them to Shopify as development.\n\n```bash\npnpm deploy:dev\n```\n\n### Preview command\nReturns links that let you preview the specified theme.\n\n```bash\npnpm preview\n```\n\n### Cheat command\n\nOpen Shopify Cheat Sheet.\n\n```bash\npnpm cheat\n```\n\n[Shopify Cheat Sheet](https://www.shopify.com/partners/shopify-cheat-sheet)\n\n### Lint command\n\nLint this project code.\n\n```bash\npnpm lint\n```\n\nFix this project code.\n\n```bash\npnpm lint:fix\n```\n\n### Test command\nRun unit testing.\n\n```bash\npnpm unit\n```\n\n```bash\npnpm unit:watch\n```\n\nRun End-to-end testing in a headless.\n\n```bash\npnpm e2e\n```\n\nRun End-to-end testing with headed browser.\n\n```bash\npnpm e2e:headed\n```\n\nGenerate End-to-end test code.\n\n```bash\npnpm e2e:codegen\n```\n\n### Share command\nUploads your theme as a new, unpublished theme in your theme library.\n\n```bash\npnpm share\n```\n\n### Package command\nPackages your local theme files into a ZIP file that can be uploaded to Shopify.\n\n```bash\npnpm package\n```\n\n### PostInstall command\n\nInstall missing TypeScript typings.\n\n```bash\npnpm postInstall\n```\n\n\u003c/details\u003e\n\n## End-to-end test\nPlease create an env file and run this command if you want to do an End-to-end test.\n\nInstall supported browsers.\n\n```bash\npnpm e2e:install\n```\n\n## Recommended IDE\n\n[Visual Studio Code](https://code.visualstudio.com/)\n\n\n## Contributes\n\nPull requests are always welcome.\n\n## Support\nI'll be trying to keep this starter kit as up-to-date as possible.\nI hope you buy me a coffee if this starter kit is helpful for you.\n\n\u003c!-- BADGES/ --\u003e\n\u003cp\u003e\n    \u003ca href=\"https://buymeacoffee.com/ricebookspk\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-yellow.png\" alt=\"Buy Me A Coffee\" width=\"130\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003c!-- /BADGES --\u003e\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkazuki-tam%2Fshopify-quick-theme-mix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkazuki-tam%2Fshopify-quick-theme-mix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkazuki-tam%2Fshopify-quick-theme-mix/lists"}