Skip to content
This repository has been archived by the owner on Jan 2, 2024. It is now read-only.

Firebase Realtime Database connector for the LoopBack framework.

License

Notifications You must be signed in to change notification settings

henriquecarv/loopback-connector-realtime-database

Repository files navigation

loopback-connector-realtime-database

Firebase Realtime Database connector for the LoopBack framework.

Codacy Badge CircleCI npm npm LICENSE Dependabot Status FOSSA Status

System Requirements

Installation

If you want to know how to get started with Loopback check this.

To add a new data source, use the data source generator:

lb datasource

Then the data source generator will prompt some questions like

  • Enter the data-source name: Firebase
  • Select the connector for Firebase: other
  • Enter the connector's module name loopback-connector-realtime-database
  • Install loopback-connector-realtime-database (Y/n) y

Then you should use a service account. Go to Project Settings > Service Accounts in the Google Cloud Platform Console. Generate a new private key and save the JSON file.

You should fill the application's datasource file which is located in /server/datasources.json with those details, You can find them in the downloaded JSON file from the Google Cloud Platform.

"Firebase": {
  "name": "Firebase",
  "projectId": "",
  "clientEmail":  "",
  "privateKey": "",
  "databaseName": "Optional, Default: projectId"
}

Connection properties

Property Type   Description ---
projectId String project_id in the JSON file ---
clientEmail String client_email in the JSON file ---
privateKey String private_key in the JSON file ---
databaseName String Firebase's project id Optional, Default: projectId

And you can actually store those private details as an Environment variables, Check source-configuration

Inspiration

Dyaa Eldin Moustafa Firestore connector

License

Copylefted (c) 2020 Henrique Carvalho da Cruz Licensed under the MIT license.