refine-firebase's Introduction

Refine-Firebase

Firebase integration tool for your Refine app

Install

npm i refine-firebase

Usage

1. Create a config file and initialize firebase.

firebaseConfig.js

import { initializeFirebase } from "refine-firebase";

export const firebaseConfig = {
    apiKey: XXXXX,
    authDomain: XXXXX,
    projectId: XXXXX,
    storageBucket: XXXXX,
    messagingSenderId: XXXXX,
    appId: XXXXX,
    databaseURL: XXXXX,
};

export const firebaseApp = initializeFirebase(firebaseConfig);

2. Create tools according to your needs.

firebaseConfig.js

import {
    FirebaseAuth,
    FirebaseDatabase,
    FirestoreDatabase,
} from "refine-firebase";

export const firebaseAuth = new FirebaseAuth();

export const firestoreDatabase = new FirestoreDatabase();

export const firebaseDatabase = new FirebaseDatabase();

3. Use dataProviders for Refine

App.js

import {firebaseAuth, firestoreDatabase }from "./firebaseConfig";

 <Refine
      dataProvider={firestoreDatabase.getDataProvider()}
      authProvider={firebaseAuth.getAuthProvider()}
    >

API Reference

Functions

Function	Description
initializeFirebase	Creates and initializes a FirebaseApp instance.

Classes

Class	Description
FirebaseAuth	Provider for generating firebase-authentication and IAuthContext for @pankod/refine auth-provider
FirestoreDatabase	Provider for initializing Firestore instance with the provided FirebaseApp and creating @pankod/refine dataProvider
FirebaseDatabase	Provider for initializing Realtime-Database instance with the provided FirebaseApp and creating @pankod/refine dataProvider