Repository files navigation

remoteStorage.js is a JavaScript library for storing user data locally in thebrowser, as well as connecting toremoteStorageservers and syncing data across devices and applications. It is also capable ofconnecting 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 inproduction.

• Seeremotestorage.io for general informationabout the remoteStorage protocol
• Readthe docs (source files indocs/)
  • Why use this?
  • Getting started
  • Data modules
  • JavaScript API
  • Usage with Node.js
• Ask questions on thecommunity forums
• If you found a potential bug, or want to propose a change,open an issue onGitHub. New issueswill usually receive a response within 24-48 hours.

To develop remoteStorage-enabled apps, you need to have aremoteStorage-compatible storage account. We recommendarmadietto (node.js) ormysteryshack (Rust) for running alocal test server.

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

If you'd like a visual UI for inspecting any RS-compatible account, you can use theRS Inspektor app (which is also implemented using this library).

remoteStorage.js is a grassroots project, developed by the community, for thecommunity. We'd be happy to count you among the manypeople whocontributedto the project so far!

Read ourContributing docsto get started.

We adhere toSemantic Versioning. This means thatbreaking changes will result in a new major version. With npm, you can makesure to only automatically upgrade to API-compatible versions by using eitherthe^ prefix, orx as indicator for flexible numbers:

"devDependencies":{"remotestoragejs":"1.x"// same as "^1.0.0"}

Original authors: Niklas Cathor, Michiel de Jong

Seelist of all contributors

Previously sponsored byNLnet