remoteStorage.js

⬡ JavaScript client library for integrating remoteStorage in apps

Browser storage
remotestorage/remotestorage.jsremotestoragejs.readthedocs.ioremotestoragejs

README

remoteStorage.js

npm Build Status

remoteStorage.js is a JavaScript library for storing user data locally in the
browser, as well as connecting to remoteStorage
servers and syncing data across devices and applications. It is also capable of
connecting and syncing data with a person's Dropbox or Google Drive account
(optional).

The library is well-tested and actively maintained. It is safe to use in
production.

Where to get help?


See remotestorage.io for general information
  about the remoteStorage protocol
Read the docs (source files indoc/)
    Why use this?
    Getting started
    Data modules
    JavaScript API
    Usage with Node.js
Ask questions on the community forums
Ask questions on IRC in #remotestorage on Libera.Chat
  (Web Chat)
  (wait a bit, if nobody's responding right away)
If you found a potential bug, or want to propose a change, [open an issue on
  GitHub](https://github.com/remotestorage/remotestorage.js/issues). New issues
  will usually receive a response within 24-48 hours.

Running a local test server


To develop remoteStorage-enabled apps, you need to have a
remoteStorage-compatible storage account. We recommend
php-remote-storage (PHP), or
armadietto (node.js), or
mysteryshack (Rust) for running a
local test server, or for self-hosting an RS server.

You can also get an account with a hoster, or use another
remoteStorage server implementation: Servers.

Developing, Contributing


remoteStorage.js is a grassroots project, developed by the community, for the
community. We'd be happy to count you among the many [people who
contributed](https://github.com/remotestorage/remotestorage.js/graphs/contributors)
to the project so far!

Read our Contributing docs
to get started.

Versioning


We adhere to Semantic Versioning. This means that
breaking changes will result in a new major version. With npm, you can make
sure to only automatically upgrade to API-compatible versions by using either
the ^ prefix, or x as indicator for flexible numbers:

  1. ``` js
  2. "devDependencies": {
  3.   "remotestoragejs": "1.x" // same as "^1.0.0"
  4. }
  5. ```

Credits


Original authors: Niklas Cathor, Michiel de Jong

See list of all contributors

Previously sponsored by NLnet
NLnet Logo