Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dalenguyen/firebase-functions-helper
A helper NPM package for Firebase Cloud Functions
https://github.com/dalenguyen/firebase-functions-helper
firebase firebase-database firebase-functions firebase-helper firestore hacktoberfest npm-package
Last synced: 14 days ago
JSON representation
A helper NPM package for Firebase Cloud Functions
- Host: GitHub
- URL: https://github.com/dalenguyen/firebase-functions-helper
- Owner: dalenguyen
- License: mit
- Created: 2018-05-11T18:34:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T17:56:09.000Z (about 2 years ago)
- Last Synced: 2024-04-14T04:36:12.074Z (7 months ago)
- Topics: firebase, firebase-database, firebase-functions, firebase-helper, firestore, hacktoberfest, npm-package
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/firebase-functions-helper
- Size: 707 KB
- Stars: 81
- Watchers: 5
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# firebase-functions-helper
[](https://badge.fury.io/gh/dalenguyen%2Ffirebase-functions-helper) [](https://travis-ci.org/dalenguyen/firebase-functions-helper)
A helper NPM package for Firebase Cloud Functions
## Tables of Contents
- [Installation](#installation)
- [Get Google Cloud Account Credentials from Firebase](#get-google-cloud-account-credentials-from-firebase)
- [Usage](#usage)
- [Contributions](#contributions)
## Installation
Install using [**npm**](https://www.npmjs.com/).
```sh
npm install firebase-functions-helper
```
## Get Google Cloud Account Credentials from Firebase
You can **Generate New Private Key** from Project Settings from [Firebase Console](https://console.firebase.google.com).
After that you need to copy the **databaseURL** for initiating the App.
## Usage
### Examples
This is the first step that you need to do before doing any other actions. You still can use the other methods from firebase helpers if you initialize the app by using other methods from Firebase docs.
```sh
const { firebaseHelper } = require('firebase-functions-helper');
const serviceAccount = require('./serviceAccountKey.json');
// Initialize Firebase App
firebaseHelper.initializeApp(serviceAccount);
```
If you want to use this package in _TypeScript_. Please follow this instruction:
```sh
import { firebaseHelper } from 'firebase-functions-helper';
import * as serviceAccount from './serviceAccountKey.json';
// Initialize Firebase App
firebaseHelper.initializeApp(serviceAccount);
```
In order to import JSON, you need to create a **typings.d.ts** in your project
```sh
// typings.d.ts
declare module "*.json" {
const value: any;
export default value;
}
```
### [Working with Firebase](docs/firebase.md)
### [Working with Firestore](docs/firestore.md)
### [Working with Realtime Database](docs/realtime.md)
## Contributions
This project is based on [firebase-functions-snippets](https://github.com/dalenguyen/firebase-functions-snippets), feel free to report bugs and make feature requests in the [Issue Tracker](https://github.com/dalenguyen/firebase-functions-helper/issues), fork and create pull requests!