firebase-data

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

Super simple live syncing for your Framer X Data objects

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FirebaseData

> A swappable replacement for the Framer data object that syncs it realtime to Firebase.

## Usage

#### Normal Data Object

```js
const data = Data({
    userLoggedIn: false,
    accentColor: "#0000ff",
})
```

#### Firebase Synced Data Object

```js
const data = FirebaseData(firebaseConfig, {
    userLoggedIn: false,
    accentColor: "#0000ff",
})
```

## Install

```
$ yarn add firebase-data
```

[Guide on using NPM packages in Framer x](https://www.framer.com/support/using-framer-x/npm-packages/)

## API

### FirebaseData(firebaseConfig, initialState, ref?)

-   `firebaseConfig` a config object from Firebase project settings.
-   `initialState` an object of default values for the Data object
-   `ref` an optional string to use as a Firebase reference to set/get data

## Troubleshooting

The most common issues in setting up `firebase-data` are related to the Firebase setup process. I've walked through the process as well some common problems & solutions in a [paper document](https://paper.dropbox.com/doc/Setting-up-Firebase-for-Firebase-Data--AnpLED5WgbSr5k8GTVvHo_IhAg-0oxp4lf7ryemVaeFAJirh).

firebase-data

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README