{"id":15481277,"url":"https://github.com/dalenguyen/firebase-functions-helper","last_synced_at":"2025-07-12T18:34:36.293Z","repository":{"id":32419784,"uuid":"133075545","full_name":"dalenguyen/firebase-functions-helper","owner":"dalenguyen","description":"A helper NPM package for Firebase Cloud Functions","archived":false,"fork":false,"pushed_at":"2022-09-16T17:56:09.000Z","size":724,"stargazers_count":81,"open_issues_count":10,"forks_count":17,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-14T04:36:12.074Z","etag":null,"topics":["firebase","firebase-database","firebase-functions","firebase-helper","firestore","hacktoberfest","npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/firebase-functions-helper","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dalenguyen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"dalenguyen","patreon":null,"open_collective":null,"ko_fi":"dalenguyen","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-05-11T18:34:50.000Z","updated_at":"2024-04-14T04:36:12.074Z","dependencies_parsed_at":"2022-07-29T03:18:01.491Z","dependency_job_id":null,"html_url":"https://github.com/dalenguyen/firebase-functions-helper","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Ffirebase-functions-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Ffirebase-functions-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Ffirebase-functions-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dalenguyen%2Ffirebase-functions-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dalenguyen","download_url":"https://codeload.github.com/dalenguyen/firebase-functions-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238053527,"owners_count":19408705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firebase","firebase-database","firebase-functions","firebase-helper","firestore","hacktoberfest","npm-package"],"created_at":"2024-10-02T05:03:22.150Z","updated_at":"2025-02-10T04:12:46.603Z","avatar_url":"https://github.com/dalenguyen.png","language":"TypeScript","funding_links":["https://github.com/sponsors/dalenguyen","https://ko-fi.com/dalenguyen"],"categories":[],"sub_categories":[],"readme":"# firebase-functions-helper\n\n[![GitHub version](https://badge.fury.io/gh/dalenguyen%2Ffirebase-functions-helper.svg)](https://badge.fury.io/gh/dalenguyen%2Ffirebase-functions-helper) [![Build Status](https://travis-ci.org/dalenguyen/firebase-functions-helper.svg?branch=master)](https://travis-ci.org/dalenguyen/firebase-functions-helper)\n\nA helper NPM package for Firebase Cloud Functions\n\n## Tables of Contents\n\n- [Installation](#installation)\n- [Get Google Cloud Account Credentials from Firebase](#get-google-cloud-account-credentials-from-firebase)\n- [Usage](#usage)\n- [Contributions](#contributions)\n\n## Installation\n\nInstall using [**npm**](https://www.npmjs.com/).\n\n```sh\nnpm install firebase-functions-helper\n```\n\n## Get Google Cloud Account Credentials from Firebase\n\nYou can **Generate New Private Key** from Project Settings from [Firebase Console](https://console.firebase.google.com).\n\nAfter that you need to copy the **databaseURL** for initiating the App.\n\n## Usage\n\n### Examples\n\nThis 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.\n\n```sh\nconst { firebaseHelper }  = require('firebase-functions-helper');\nconst serviceAccount = require('./serviceAccountKey.json');\n\n// Initialize Firebase App\nfirebaseHelper.initializeApp(serviceAccount);\n```\n\nIf you want to use this package in _TypeScript_. Please follow this instruction:\n\n```sh\nimport { firebaseHelper } from 'firebase-functions-helper';\nimport * as serviceAccount from './serviceAccountKey.json';\n\n// Initialize Firebase App\nfirebaseHelper.initializeApp(serviceAccount);\n\n```\n\nIn order to import JSON, you need to create a **typings.d.ts** in your project\n\n```sh\n// typings.d.ts\ndeclare module \"*.json\" {\n    const value: any;\n    export default value;\n}\n```\n\n### [Working with Firebase](docs/firebase.md)\n\n### [Working with Firestore](docs/firestore.md)\n\n### [Working with Realtime Database](docs/realtime.md)\n\n## Contributions\n\nThis 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!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalenguyen%2Ffirebase-functions-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdalenguyen%2Ffirebase-functions-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdalenguyen%2Ffirebase-functions-helper/lists"}