tubbz-alt / zendesk-app

The System76 zendesk app

Zendesk App

A Zendesk App for System76

---

This repository contains a nuxt site used as a zendesk app that enhance the workflow for System76 employees working in Zendesk. While this repository is open source, the application are very specific to our work flow and will be of no use in other people's instance of Zendesk. We keep this repository open in hopes people can see, learn, and possibly enhance how we create these apps.

Requirements

• A recent version of node

Setup

Simply cd into the app you are interested in and run npm ci to install the dependencies.

You will also want to add the app you are working on to a zendesk instance. At System76, we have a staging instance of Zendesk that we do all of our testing on.

Running

Simply run npm start, and open up your zendesk instance. That's it! The installed app will detect if your localhost server is running, and redirect to your local development copy if it is. Hot reloading should be enabled so you can hack away!

Adding sections

If you plan to add pages / zendesk sections (not modals), you will need to edit the zendesk/manifest.json file. This is the file that tells zendesk what to add our app to. The value can stay the normal assets/index.html file.

NOTE You will need to redeploy the Zendesk app for these to take effect. Please see the section below for how to do that.

Deployment

For the main app, everything is deployed on push to master or staging branch, just like our other repositories.

To deploy the Zendesk app, you will need the Zendesk App Tools installed. Next, just cd into the zendesk folder, run zat package, and upload that package to Zendesk.

License

This project is licensed under GPL-3.0. See LICENSE for more information.