https://github.com/felixtellmann/shopify-theme-dev
https://github.com/felixtellmann/shopify-theme-dev
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/felixtellmann/shopify-theme-dev
- Owner: FelixTellmann
- Created: 2022-12-03T17:34:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T10:37:48.000Z (over 1 year ago)
- Last Synced: 2024-11-24T19:48:25.767Z (over 1 year ago)
- Language: TypeScript
- Size: 565 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Please note**: This framework is in active development. I'm keeping it in a cycle of 0.0.x releases at the moment to indicate that it’s not even ready for its 0.1.0. Active work is being done on documentation and features, and APIs should not necessarily be considered stable. At the same time, it is more than a toy project or proof of concept, and I am actively using it for my own application development.
## S6 - Shopify Theme Development kit
This runs a local FTP server (on localhost) that will communicate with Shopify over HTTP API and allows you to upload/download/edit your theme files and assets using your favorite FTP client.
Note: this tool is built with [Node.js](https://nodejs.org) and is installed via [npm](https://www.npmjs.org) so make sure to have Node installed. I have tested this on Mac and Windows.
### Installation:
npm install shopify-theme-dev
Setting up env variables:
```dotenv
SHOPIFY_CMS_SHOP
SHOPIFY_CMS_STOREFRONT_DIGEST
SHOPIFY_CMS_ACCESS_TOKEN
SHOPIFY_CMS_THEME_ID
SHOPIFY_CMS_FOLDER
```
### Usage:
`shopify-typed-settings`
### Get Shopify API Key(s)
You will need a Shopify API key-pair.
* Go to: [{store-name}.myshopify.com/admin/apps](https://myshopify.com/admin/apps)
* Click "Private Apps" in the top right corner
* Click on an existing private app or create a new one
* Copy the API key and Password
* You will need access to read / write Themes