Skip to content
This repository has been archived by the owner on Jun 9, 2018. It is now read-only.

Latest commit

 

History

History
29 lines (22 loc) · 1.19 KB

README.md

File metadata and controls

29 lines (22 loc) · 1.19 KB

File-system

A library that helps with storing files, retrieving, removing files using the FileSystem API. The Filesytem API is not stable and neither is this library. Consider this therefore HIGHLY EXPERIMENTAL

###Background Developed for use in Enketo Smart Paper, but without external dependencies. It can be used in any situation requiring persistent folder-based file storage inside a browser.

###Features

  • persistent storage of files in folders with a unique ID
  • lightweight - only includes features that are required for enketo

###Support

  • Chrome for Desktop
  • Opera for Desktop

###Prerequisites

  • jQuery

###Development

  • styleguide used: https://github.com/rwaldron/idiomatic.js/
  • tests can only be run from a webserver, need to accept filesystem access upon first run
  • for now JSDoc is used to be able to compile with Google Closure (but not yet in Advanced Mode)
  • peephole Chrome plugin or chrome://settings/cookies is your friend

###Future

  • Sample usage page
  • Automated testing on Travis (with node.js webserver?)
  • Would like to refactor this and use a workflow that emits events to more elegantly deal with all the chained asynchronous function calls