🚀 Firetstore Helper for React Native

A utility package for React Native apps which provides an abstract layer around Firebase functionalities, particularly focusing on authentication, and syncing between Firestore and AsyncStorage.

Features

• 🔒 Firebase Authentication with Google.
• 💾 Seamless synchronization between Firestore and AsyncStorage.
• 📖 Comprehensive logging using mayo-logger.
• 📦 Lightweight & minimal setup.

Installation

yarn add mayo-firestore-write

Prerequisites

Ensure you have @react-native-firebase/auth, @react-native-firebase/firestore, and @react-native-async-storage/async-storage installed in your React Native project.

Usage

Firebase Configuration Extraction

mayo-firestore-write relies on mayo-firebase-config which is an embedded mechanism that allows automatic extraction of Firebase configuration from your app's GoogleService-Info.plist. This helps streamline the Firebase setup process, especially if you're looking to avoid hardcoding Firebase configurations or manually importing them.

How does it work?

Under the hood, we use native modules to directly read from the GoogleService-Info.plist and provide a ready-to-use configuration object for Firebase initialization in React Native.

1. Firebase Authentication

To sign in using Firebase with Google credentials:

import { signInFirebase } from 'mayo-firestore-write';

const googleCredential = {
  // your google credential here. You can use mayo-firebase-auth package to get it.
};

signInFirebase(googleCredential)
  .then(user => {
    console.log("Signed in user:", user);
  })
  .catch(error => {
    console.error("Error during Firebase sign-in:", error);
  });

2. AsyncStorage Operations

To load data from AsyncStorage:

import { loadFromAsyncStorage } from 'mayo-firestore-write';

const data = await loadFromAsyncStorage();

To write data to AsyncStorage:

import { writeToAsyncStorage } from 'mayo-firestore-write';

const sampleData = {
  key1: 'value1',
  key2: 'value2',
  // ...
};
await writeToAsyncStorage(sampleData);

3. Firestore Operations

To load data from Firestore:

import { loadFromFirestore } from 'mayo-firestore-write';

const data = await loadFromFirestore();

To sync AsyncStorage data to Firestore:

import { syncAsyncStorageToFirestore } from 'mayo-firestore-write';

await syncAsyncStorageToFirestore();

4. Removing Data from AsyncStorage

To remove a particular data (identified by its storageKey) from AsyncStorage:

import { flushFromAsyncStorage } from 'mayo-firestore-write';

await flushFromAsyncStorage();

This function will attempt to locate the data associated with the storageKey in AsyncStorage and then remove it. All actions will be logged using the integrated mayo-logger module.

Contribute

Contributions are always welcome! Please read the contribution guidelines first.

License

mayo-firestore-write is licensed under MIT.