Introduction

This is a guide to creating and editing themes using the SiteChef CLI tool

The SiteChef CLI tool and the base themes supplied with SiteChef have been designed to be easy-to-modify, simple to setup and, as far as possible use common open standards and open source tooling.

Our goal is to support developers to help them deliver top quality, responsive websites for their clients as quickly as possible.

If you have any problems with any of the aspects of theme generation, don't hesitate to get in touch at [email protected]. This documentation and the SiteChef CLI are open source and we welcome any contributions.

Quickstart

  1. install node.js
  2. install yarn 1.x
  3. install nvm
  4. set the node version to 8.2.1 - this is a requirement until we are able to successfully upgrade the sitechef-cli
  5. install the sitechef command line utility yarn global add sitechef
  6. clone your theme to a local directory sitechef init [your-api-key] [optional directory name] eg: sitechef init 999999999888888
  7. move to your directory (cd [your-directory]) and run the local server sitechef serve
  8. view your theme hosted locally at http://localhost:3999/
  9. when you are happy with your changes, publish your theme back to sitechef with sitechef publish