2024-08-23: this project is no longer used and is now archived.
A Zendesk App that fetches contextual information about a ticket from its custom project field.
To run the app locally, you'll need to have the following installed:
- Ruby 2.x
- Node.js 12.13.0 or greater
git clone [email protected]:dxw/project_wisdom.git
./script/setup
Necessary if you want to run the server, but not if all you want is to run the test suite.
Where "username" is your Zendesk login with /token
appended to the end (e.g. [email protected]/token
), and "password" is
available in the dxw 1Password as "Zendesk API Key".
script/server
You'll need the Airtable API Key and Base Key (available from the dxw 1Password).
Go to a ticket in Zendesk and append ?zat=true
to the url. eg:
https://dxw.zendesk.com/agent/tickets/123345?zat=true
Click on the Apps
button on the ticket view to see the app in action!
Run the following script:
script/test
To rebuild the app locally following changes, run
script/build
to build the app in the /dist
folder using Webpack, and generate a zip file of the
project in dist/tmp
.
The repo is set up to automatically push to Zendesk on every main
push, but in case you want to
do this manually and push the updated package to Zendesk, you can run:
script/build --push
This assumes you have the correct credentials in your .zat
file.
When adding new fields, these are the files you will need to look at:
default.js
, project.js
For the relating spec changes:
app.spec.js
, project.spec.js
my-project.json
is the test data used within the spec files.