No description, website, or topics provided.
Clone or download
Latest commit bd7783b Jan 8, 2019

README.md

Zendesk Apps Tools

Description

Zendesk Apps Tools (ZAT) are a collection of local development tools that simplify building and deploying Zendesk apps.

Owners

This repo is owned and maintained by the Zendesk Apps team. You can reach us on vegemite@zendesk.com. We are located in Melbourne.

Install and use ZAT

ZAT is a Ruby gem. You don't need to know Ruby to use the tools but you do need to install Ruby to install the gem.

To install, run gem install zendesk_apps_tools.

To get the latest version, run gem update zendesk_apps_tools.

For information on using the tools, see Zendesk App Tools on developer.zendesk.com.

Work on ZAT

If you want to help develop this tool, clone this repo and run bundle install.

ZAT uses a gem called ZAS. If you're developing ZAT, you'll probably want to edit code in ZAS too. To do so, you need to clone the ZAS repo and add the following line at the end of Gemfile in the ZAT project:

gem 'zendesk_apps_support', path: '../zendesk_apps_support'

Then, comment-out the line referring to zendesk_apps_support in this project's .gemspec file.

# s.add_runtime_dependency 'zendesk_apps_support', '~> X.YY.ZZ'

The path should point to your local ZAS directory. In this way, your clone of ZAT will use a local version of ZAS, which is very helpful for development. Run a bundle install after changing the Gemfile.

Testing

This project uses rspec, which you can run with bundle exec rake.

Contribute

Improvements are always welcome. To contribute:

  • Put up a PR into the master branch.
  • CC and get two +1 from @zendesk/vegemite.

Bugs

You can report bugs as issues here on GitHub. You can also submit a bug to support@zendesk.com. Mention "zendesk_apps_tools" in the ticket so it can be assigned to the right team.

Copyright and license

Copyright 2013 Zendesk Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.