https://github.com/fobo66/algolia-firebase-functions

Firebase Cloud Functions for sync Firebase Database or Firestore with Algolia in real time
https://github.com/fobo66/algolia-firebase-functions

Last synced: 4 days ago
JSON representation

Firebase Cloud Functions for sync Firebase Database or Firestore with Algolia in real time

• Host: GitHub
• URL: https://github.com/fobo66/algolia-firebase-functions
• Owner: fobo66
• License: apache-2.0
• Created: 2017-07-02T18:56:27.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-11-15T14:38:10.000Z (5 days ago)
• Last Synced: 2024-11-15T15:41:19.352Z (5 days ago)
• Language: TypeScript
• Homepage:
• Size: 5.59 MB
• Stars: 32
• Watchers: 4
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Algolia <-> Firebase cloud functions

[![npm](https://img.shields.io/npm/v/algolia-firebase-functions.svg)](https://www.npmjs.com/package/algolia-firebase-functions)

![Tests](https://github.com/fobo66/algolia-firebase-functions/workflows/Tests/badge.svg)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e0db542266204846b3a47018839453f4)](https://www.codacy.com/manual/fobo66/algolia-firebase-functions?utm_source=github.com&utm_medium=referral&utm_content=fobo66/algolia-firebase-functions&utm_campaign=Badge_Grade)

Useful library to keep your [Firebase Database](https://firebase.google.com/docs/database) of [Firebase Cloud Firestore](https://firebase.google.com/docs/firestore) data in sync with [Algolia](https://algolia.com) for easy search.

Starting from version 2.0, this library supports Cloud Functions v1.0. If you need to support beta Cloud Functions, use version 1.0.3 instead.

Starting from version 4.0.0, this library supports Node >= 10 and no longer supports Node 8. If you still need to support Node 8, use version 3.3.0 instead.

Starting from version 4.1.2, this library supports only ES6 modules or Typescript.

Starting from version 5.0.0, this library supports Node >= 14 and no longer supports Node 10 and 12. If you still need to support Node 10 or 12, use version 4.1.2 instead.

Starting from version 6.0.0, this library uses Algolia SDK v5.

## Installation

In your `functions` directory:

``` bash

 npm install --save algolia-firebase-functions

```

## Usage

To use this library in your Functions, first of all you need to set environmental variables for Algolia to initialize connection. Grab your API keys [here](https://algolia.com/dashboard) first.

Open Terminal, go to your `functions` directory and input these commands:

``` bash

firebase functions:config:set algolia.app=""

firebase functions:config:set algolia.key=""

firebase functions:config:set algolia.index=""

```

Then, in your functions' `index.js` file, paste the following lines:

``` js

import { config, database } from 'firebase-functions';

import admin from 'firebase-admin';

import { searchClient } from "@algolia/client-search";

import { syncAlgoliaWithFirebase } from 'algolia-firebase-functions';

admin.initializeApp(config().firebase);

const algolia = searchClient(functions.config().algolia.app,

                              functions.config().algolia.key);

const index = functions.config().algolia.index;

export const syncAlgoliaFunction = database.ref('/myRef/{childRef}').onWrite(

   (change, context) => syncAlgoliaWithFirebase(algolia, index, change)

)

```

If you're using [Firebase Cloud Firestore](https://firebase.google.com/docs/firestore/), you can use the following code:

```js

import { firestore } from 'firebase-functions';

import { syncAlgoliaWithFirestore } from 'algolia-firebase-functions';

export const syncAlgoliaFunction = firestore.document('/myDocument/{childDocument}').onWrite(

   (change, context) => syncAlgoliaWithFirestore(algolia, index, change);

);

```

And redeploy your functions:

```bash

firebase deploy --only functions

```

Now, after any changes made with your references, it will be sent to Algolia, so you'll be sure that users can search on the newest data.