Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henriquecarv/loopback-connector-realtime-database
Firebase Realtime Database connector for the LoopBack framework.
https://github.com/henriquecarv/loopback-connector-realtime-database
firebase firebase-database firebase-db firebase-realtime-database henriquecarv loopback loopback-connector nodejs package strongloop strongloop-connector
Last synced: 3 months ago
JSON representation
Firebase Realtime Database connector for the LoopBack framework.
- Host: GitHub
- URL: https://github.com/henriquecarv/loopback-connector-realtime-database
- Owner: henriquecarv
- License: mit
- Archived: true
- Created: 2018-08-17T19:01:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T14:17:47.000Z (about 1 year ago)
- Last Synced: 2024-09-19T12:05:45.054Z (4 months ago)
- Topics: firebase, firebase-database, firebase-db, firebase-realtime-database, henriquecarv, loopback, loopback-connector, nodejs, package, strongloop, strongloop-connector
- Language: JavaScript
- Size: 1.3 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# loopback-connector-realtime-database
Firebase Realtime Database connector for the LoopBack framework.
[](https://app.codacy.com/app/henriquecarv/loopback-connector-realtime-database?utm_source=github.com&utm_medium=referral&utm_content=henriquecarv/loopback-connector-realtime-database&utm_campaign=Badge_Grade_Settings)
[](https://circleci.com/gh/henriquecarv/loopback-connector-realtime-database)
[](https://www.npmjs.com/package/loopback-connector-realtime-database)
[](https://www.npmjs.com/package/loopback-connector-realtime-database)
[](./LICENSE)
[](https://dependabot.com)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fhenriquecarv%2Floopback-connector-realtime-database?ref=badge_shield)
## System Requirements
- **[NodeJS](https://nodejs.org/en/)** (version >= 10).
## Installation
If you want to know how to get started with Loopback [check this][5].
To add a new data source, use the data source generator:
```sh
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][4] 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.
```json
"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][6]
### Inspiration
Dyaa Eldin Moustafa [Firestore connector][3]
### License
Copylefted (c) 2020 [Henrique Carvalho da Cruz][1] Licensed under the [MIT license][2].
[1]: https://henriquecarv.com
[2]: ./LICENSE
[3]: https://github.com/dyaa/loopback-connector-firestore
[4]: https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts
[5]: http://loopback.io/getting-started/
[6]: https://loopback.io/doc/en/lb3/Environment-specific-configuration.html#data-source-configuration