Skip to content

README.md

Latest commit

 

History

History
44 lines (29 loc) · 1.96 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.96 KB

@fireproof/drive

Fireproof is an embedded JavaScript document database that runs in the browser (or anywhere with JavaScript) and connects to any cloud.

This module, @fireproof/drive, allows you to connect your Fireproof database to google drive via pre defined google drive api endpoints, enabling you to sync your data across multiple users in real-time.

Get started

We assume you already have an app that uses Fireproof in the browser, and you want to setup collaboration among multiple users via the cloud. To write your first Fireproof app, see the Fireproof quickstart, otherwise read on.

1. Install

In your existing Fireproof app install the connector:

npm install @fireproof/drive

2. Connect

You're all done on the server, and ready to develop locally and then deploy with no further changes. Now you just need to register the google drive gateway in your client code. Fireproof already deployed the google drive api endpoints, so you don't need anything except fresh access token to sync data with your drive

// you already have this in your app
import { useFireproof } from "use-fireproof";
// add this line
import { registerGDriveStoreProtocol } from "@fireproof/drive";

You should call registerGDriveStoreProtocol('gdrive:', access_token) before calling useFireproof() hook

registerGDriveStoreProtocol('gdrive:', access_token)
const { database } = useFireproof("my-app-database-name", {
    storeUrls: {
      base: "gdrive://",
    },
  });

3. Collaborate

Now you can use Fireproof as you normally would, and it will sync in realtime with other users. Any existing apps you have that use the live query or subscription APIs will automatically render multi-user updates.