Annotate Images (or goats) On The Web™
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
tests
translations
zendesk-app
.gitignore fix tests and resolve #95 Mar 23, 2018
.nvmrc
.travis.yml
LICENSE
README.md
elm-package.json
index.html
manifest.json
package.json 1.0.5 release Mar 23, 2018

README.md

G.O.A.T. (Graphic Ornamentation and Annotation Tool) Travis

G.O.A.T. Logo

Demo

G.O.A.T. Demo

Motivation

I wanted to help Support Agents give more context to their screenshots!

https://www.zendesk.com/apps/goat/

Credits

Epic 🐐-ing to Alan Hogan for the acronym behind the 🐐, some bugfixes, and more icons!

👏 Huge thanks to Jian Wei Liau for some beautiful icons and logo! 👏

Development

Dead simple setup

Get yourself the Elm programming language:

On node 6+: npm install -g elm && npm install

Then you can just do elm-make src/Main.elm --output=elm.js and open index.html.

Nicer workflow

Use elm-live (npm install -g elm-live) and then run npm run dev.

This will open a browser tab with CSS hot reloading and page refreshing on Elm code changes.

Working on the Zendesk App

npm install will install the necessary dev tools.

npm start will run a development server, you can preview your changes on Zendesk by adding the query string: ?zat=true to the end of the Zendesk Support url.

Testing

Setup for first time Elm testers:

npm i -g elm-test

Use npm test to run the elm-test unit, fuzz, and view tests.

Contributing

This project is welcome to any PRs, first time Elm programmer or not!

If it's a change requiring a decent amount of work, let's chat first!

DM me on The Elm Language Slack (@greg.ziegan)

Or, make an issue!