https://github.com/asatani-inc/shopify-theme-development-boilerplate
Boilerplate for Shopify theme development
https://github.com/asatani-inc/shopify-theme-development-boilerplate
gem goodcheck npm shopify shopify-theme theme-check
Last synced: 3 months ago
JSON representation
Boilerplate for Shopify theme development
- Host: GitHub
- URL: https://github.com/asatani-inc/shopify-theme-development-boilerplate
- Owner: asatani-inc
- Created: 2021-06-14T05:45:19.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-07T15:57:23.000Z (over 2 years ago)
- Last Synced: 2025-01-26T08:15:17.632Z (5 months ago)
- Topics: gem, goodcheck, npm, shopify, shopify-theme, theme-check
- Language: Liquid
- Homepage:
- Size: 682 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Boilerplate for Shopify theme development
This repository provides boilerplate for Shopify theme development with the default theme.
## Requirements
- [nodenv](https://github.com/nodenv/nodenv#installation)
- [yarn](https://classic.yarnpkg.com/en/docs/install)
- [rbenv](https://github.com/rbenv/rbenv#installation)
- [bundler](https://github.com/rubygems/bundler)
## Setup
### Installation
```bash
yarn install
bundle install
```
### Make your own config.yml for development
In order to make `config.yml`, it can be done either by using Theme Kit or manually.
#### Theme Kit
```bash
yarn run config -p= -s= -t= -d=src
```
#### Manual
```bash
cp -ip config.sample.yml config.yml
```
```yml
development:
password: shppa_00000000000000000000000000000000 # your password for shopify api
theme_id: "000000000000" # your woking theme id
store: test.myshopify.com # your store url
directory: src
```
### Get latest theme on Shopify
```bash
yarn run get
```
### Deploy your changes to Shopify
```bash
yarn run deploy
```
or if you want to continuously deploy
```bash
yarn run watch
```
## Helpful references for development
- [Shopify Theme Kit](https://shopify.dev/tools/theme-kit)