Skip to content

Developer Documentation

Derek Williams edited this page Mar 8, 2016 · 5 revisions

Approach

Jiffy is a JavaScript single-page app for flat file viewing and editing. It uses the JavaScript File API for all local file operations.

Jiffy uses the following libraries:

Jiffy deliberately does not use:

  • jQuery. jqLite only, thank you. Because it's the Angular way.
  • RequireJS. Because I wanted to see if I could live without it. I did, quite happily.
  • Bulky UI widget libraries. Jiffy sticks to standard HTML with AngularJS.

Code Docs

See the Ngdocs.

Use grunt docs to update the ngdocs. Then, run node webserver.js and open in a browser.

License

Jiffy is released under the ISC License. See LICENSE.txt.

Contributing

The usual: fork, work your magic, send me a pull request.

To share a file format definition, add it to a new folder under file-definitions and include the name (commented out) in definition-names.txt.

Clone this wiki locally