themekit

module
v0.6.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2017 License: MIT

README

Theme Kit Go Report Card Build StatusGoDoc

Shopify Theme Manipulation CLI

Theme Kit is a cross-platform tool for building Shopify Themes. Theme Kit is a single binary that has no dependencies.

Features

  • Upload Themes to Multiple Environments
  • Fast Uploads and Downloads
  • Watch for local changes and upload automatically to Shopify
  • Works on Windows, Linux and macOS

Read more about it on the website

Installation

You can find installation instructions for each platform on the Docs Website

Setup, Usage and Commands

Please find further usage instructions on the theme kit website

Development

Themekit requires go 1.8. You can setup your development environment by running the following:

go get -u github.com/Shopify/themekit
cd $GOPATH/src/github.com/Shopify/themekit
make [mac_tools|linux_tools] # install platform specific development tools
glide install # see https://github.com/Masterminds/glide for glide usage
make # build themekit
theme version #should output the current themekit version

This will install theme kit into $GOPATH/bin and you will now have access to the theme command.

Contribution Guidelines

We welcome your contributions to the project. There are a few steps to take when looking to make a contribution.

  • Open an issue to discuss the feature/bug
  • If feature/bug is deemed valid then fork repo.
  • Implement patch to resolve issue.
  • Include tests to prevent regressions and validate the patch.
  • Update the docs for any API changes.
  • Submit pull request and mention maintainers. Current maintainers are @tanema, @chrisbutcher

Authors

Chris Saunders, Tim Anema, Chris Butcher, Jakob Külzer

Directories

Path Synopsis
cmd
Package cmd is the package that handled the command line commands.
Package cmd is the package that handled the command line commands.
theme command
Package kit is all of the tools used to interact with shopify themes.
Package kit is all of the tools used to interact with shopify themes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL