Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gogovega/firebase-config-node

Node-RED Config Node to communicate with Google Firebase
https://github.com/gogovega/firebase-config-node

admin config database firebase firestore node-red realtime

Last synced: 6 days ago
JSON representation

Node-RED Config Node to communicate with Google Firebase

Host: GitHub
URL: https://github.com/gogovega/firebase-config-node
Owner: GogoVega
License: mit
Created: 2023-09-09T16:34:47.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-09-28T12:21:38.000Z (3 months ago)
Last Synced: 2024-09-28T12:25:09.928Z (3 months ago)
Topics: admin, config, database, firebase, firestore, node-red, realtime
Language: TypeScript
Homepage:
Size: 1.48 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        


  Node-RED config-node to communicate with Firebase



  

  

    


    Report Bug

    ·

    Request Feature

    ·

    Discussion

  





  

  

  

  

  

  






> [!CAUTION]

> **BREAKING CHANGES**: v0.2.0 - the required version of Node.js is now >=18 and the required version of Node-RED >=3

## What is it?

This repo is used by the following modules:

- RTDB: [@gogovega/node-red-contrib-firebase-realtime-database](https://github.com/GogoVega/node-red-contrib-firebase-realtime-database)

- Cloud Firestore: [@gogovega/node-red-contrib-cloud-firestore](https://github.com/GogoVega/node-red-contrib-cloud-firestore)

- Cloud Storage: @gogovega/node-red-contrib-cloud-storage: **Not yet developed**

Of coure, you can use it for your own module.

## Preview

Below is a current overview of the config node, its appearance may change in the future.

Screenshot of the Connection tab



  



Screenshot of the Security tab



  



Screenshot of the Databases tab



  



## Authentication Methods

- `Anonymous`

- `Email`

- `Private Key` (Firebase Admin Node.js SDK)

- `Custom Token` (Generated with Private Key)

## Available Databases

- RTDB

- Firestore

## How to use?

1. Add this package as dependency

```bash

npm i @gogovega/firebase-config-node@latest --omit=dev --save

```

2. Retrieve the config-node and use the built-in methods

```js

module.exports = function (RED) {

  function MyFirebaseNode(this, config) {

    RED.nodes.createNode(this, config);

    // Get the config-node

    const configNode = RED.nodes.getNode(config.database);

    // Init the RTDB and subscribe to the communication status

    configNode.addStatusListener(this.id, "rtdb");

    // The RTDB reference instance

    const rtdb = configNode.rtdb.database;

    // Gets data from msg.path and yields a `payload`

    this.on("input", async (msg, send, done) => {

      try {

        const snapshot = await configNode.rtdb.get(msg.path);

        send({ payload: snapshot });

        done();

      } catch (error) {

        done(error);

      }

    });

    // Unsubscribe the communication status

    this.on("close", (done) => configNode.removeStatusListener(done));

  }

  RED.nodes.registerType("my-firebase-node", MyFirebaseNode);

};

```

## Getting Started Link

- [Firebase Site](https://firebase.google.com/): What is Firebase?

- [Firestore Nodes](https://github.com/GogoVega/node-red-contrib-cloud-firestore): You search for the Google Cloud Firestore Nodes?

- [Firebase RTDB Nodes](https://github.com/GogoVega/node-red-contrib-cloud-firestore): You search for the Firebase Realtime Databases Nodes?

- [Change Log](./CHANGELOG.md): Whats changed?

## License

MIT License

Copyright (c) 2023 Gauthier Dandele

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.