https://github.com/gregziegan/goat
Annotate Images (or goats) On The Web™
https://github.com/gregziegan/goat
annotations elm functional-programming image-annotation image-editing svg
Last synced: 7 months ago
JSON representation
Annotate Images (or goats) On The Web™
- Host: GitHub
- URL: https://github.com/gregziegan/goat
- Owner: gregziegan
- License: mit
- Created: 2017-02-25T21:33:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-28T16:59:07.000Z (almost 6 years ago)
- Last Synced: 2025-04-22T15:13:45.637Z (7 months ago)
- Topics: annotations, elm, functional-programming, image-annotation, image-editing, svg
- Language: Elm
- Homepage: http://gregziegan.github.io/goat
- Size: 2.5 MB
- Stars: 74
- Watchers: 5
- Forks: 9
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# G.O.A.T. (Graphic Ornamentation and Annotation Tool) 
## 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](https://github.com/alanhogan) for the acronym behind the 🐐, some bugfixes, and more icons!
👏 Huge thanks to [Jian Wei Liau](https://twitter.com/madebyjw) for some beautiful icons and logo! 👏
## Development
#### Dead simple setup
Get yourself the [Elm programming language](http://elm-lang.org/):
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](https://elmlang.herokuapp.com) (**@greg.ziegan**)
Or, make an issue!