This is a JavaScript client library for the Dropbox API, written in CoffeeScript, suitable for use in both modern browsers and in server-side code running under node.js.
This library is tested against the following JavaScript platforms
Keep in mind that the versions above are not hard requirements.
The getting started guide will help you get your first dropbox.js application up and running.
Peruse the source code of the sample apps, and borrow as much as you need.
The dropbox.js API reference can be a good place to bookmark while building your application.
If you run into a problem, take a look at the dropbox.js GitHub issue list. Please open a new issue if your problem wasn't already reported.
This project mostly follows semantic versioning.
Until the library reaches version 1.0, changes to the public API will always carry a minor version bump, such as going from 0.7.2 to 0.8.0. Patch releases (e.g. 0.8.0 -> 0.8.1) may introduce new features that don't break the public API.
This library is written in CoffeeScript. This document can help you understand if that matters to you.
The development guide will make your life easier if you need to change the source code.
This lists the most serious problems that you might run into while using
dropbox.js. See
the GitHub issue list for a
full list of outstanding problems.
Reading and writing binary files is currently broken. This issue will be fixed in a future release.
The current version of the built-in Chrome authentication driver doesn't work on new-style Chrome Applications. This issue will be fixed in a future release.
The library only works when used from https:// pages, due to
these issues.
Reading and writing binary files is unsupported.
At the moment, there are no plans for fixing these issues.
The library is Copyright (c) 2012 Dropbox Inc., and distributed under the MIT License.