Zendesk Theme

This repo contains the files necessary for local theme development of our Zendesk theme(s). Inside this repo you should have all the capabilities for local development, as well as creating a production .zip folder to upload to Zendesk.

Getting Started

Before getting started you will want to make sure to install the Zendesk App Tools. Make sure you have Ruby installed, then inside of this directory go ahead and run:

$ gem install rake

then:

$ gem install zendesk_apps_tools

Once those are both installed you can run yarn within this repo. As soon as all the dependencies have been downloaded you can start development. By running:

$ yarn develop

or if you'd like to develop on the Bambu theme just append with a -t bambu:

$ yarn develop -t bambu

it will create a development build and run the Zendesk app tools to load up the theme preview. You will be prompted for the password, and those credentials can be found here. Because we use 2FA with our Zendesk admin account, the password is our local theme development API key. The Zendesk app tools should live reload the browser throughout development.

Uploading to Production

Currently there is no programmatic way to upload the theme while developing it, so we have to manually go into the Zendesk admin. By running:

$ yarn build

it will create a production build of the theme as well as creating a .zip file that will be used to upload to the admin area inside of Zendesk. These instructions will help you import the .zip file into the themes area.

Login credentials for the Zendesk admin can be found here.