{"id":28539814,"url":"https://github.com/transistorsoft/react-native-background-geolocation-firebase","last_synced_at":"2026-03-09T04:01:37.460Z","repository":{"id":37752423,"uuid":"143345440","full_name":"transistorsoft/react-native-background-geolocation-firebase","owner":"transistorsoft","description":"Firebase Adapter for React Native Background Geolocation","archived":false,"fork":false,"pushed_at":"2024-10-17T15:20:21.000Z","size":228,"stargazers_count":24,"open_issues_count":1,"forks_count":4,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-20T02:43:49.049Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transistorsoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-02T21:12:42.000Z","updated_at":"2024-10-17T15:20:25.000Z","dependencies_parsed_at":"2023-11-15T06:36:16.064Z","dependency_job_id":"b068a09a-d493-4cea-a42d-6f987ec6787f","html_url":"https://github.com/transistorsoft/react-native-background-geolocation-firebase","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.21875,"last_synced_commit":"25380c8b168d9a7303635032350f588045dd5a93"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/transistorsoft/react-native-background-geolocation-firebase","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Freact-native-background-geolocation-firebase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Freact-native-background-geolocation-firebase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Freact-native-background-geolocation-firebase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Freact-native-background-geolocation-firebase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transistorsoft","download_url":"https://codeload.github.com/transistorsoft/react-native-background-geolocation-firebase/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Freact-native-background-geolocation-firebase/sbom","scorecard":{"id":896994,"data":{"date":"2025-08-11","repo":{"name":"github.com/transistorsoft/react-native-background-geolocation-firebase","commit":"25380c8b168d9a7303635032350f588045dd5a93"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 2/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: android/gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 10 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-24T14:06:07.228Z","repository_id":37752423,"created_at":"2025-08-24T14:06:07.231Z","updated_at":"2025-08-24T14:06:07.231Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30282529,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-06-09T18:33:28.553Z","updated_at":"2026-03-09T04:01:37.452Z","avatar_url":"https://github.com/transistorsoft.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"react-native-background-geolocation-firebase \u0026middot; [![npm](https://img.shields.io/npm/dm/react-native-background-geolocation-firebase.svg)]() [![npm](https://img.shields.io/npm/v/react-native-background-geolocation-firebase.svg)]()\n============================================================================\n\n[![](https://dl.dropboxusercontent.com/s/nm4s5ltlug63vv8/logo-150-print.png?dl=1)](https://www.transistorsoft.com)\n\n-------------------------------------------------------------------------------\n\nFirebase Proxy for [React Native Background Geolocation](https://github.com/transistorsoft/react-native-background-geolocation).  The plugin will automatically post locations to your own Firebase database, overriding the `react-native-background-geolocation` plugin's SQLite / HTTP services.\n\n![](https://dl.dropboxusercontent.com/s/2ew8drywpvbdujz/firestore-locations.png?dl=1)\n\n----------------------------------------------------------------------------\n\nThe **[Android module](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase)** requires [purchasing a license](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase).  However, it *will* work for **DEBUG** builds.  It will **not** work with **RELEASE** builds [without purchasing a license](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase).\n\n----------------------------------------------------------------------------\n\n## :large_blue_diamond: Installing the Plugin\n\n-------------------------------------------------------------\n\n:warning: If you have a previous version of **`react-native-background-geolocation-firebase \u003c 0.3.0`** installed into **`react-native \u003e= 0.60`**, you should first `unlink` your previous version as `react-native link` is no longer required.\n\n```bash\n$ react-native unlink react-native-background-geolocation-firebase\n```\n\n-------------------------------------------------------------\n\n### From yarn\n\n```bash\n$ yarn add react-native-background-geolocation-firebase\n```\n\n### From npm\n\n```\n$ npm install react-native-background-geolocation-firebase --save\n```\n\n### Latest from Github\n\n```\n$ npm install git+https://git@github.com:transistorsoft/react-native-background-geolocation-firebase.git --save\n```\n\n## :large_blue_diamond: Setup Guides\n\n## iOS\n\n- [Auto-linking Setup](docs/INSTALL-IOS-AUTO.md)\n\n## Android\n\n- [Auto-linking Setup](docs/INSTALL-ANDROID-AUTO.md)\n\n## :large_blue_diamond: Configure your license\n\n1. Login to Customer Dashboard to generate an application key:\n[www.transistorsoft.com/shop/customers](http://www.transistorsoft.com/shop/customers)\n![](https://gallery.mailchimp.com/e932ea68a1cb31b9ce2608656/images/b2696718-a77e-4f50-96a8-0b61d8019bac.png)\n\n2. Add your license-key to `android/app/src/main/AndroidManifest.xml`:\n\n```diff\n\u003cmanifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n    package=\"com.transistorsoft.backgroundgeolocation.react\"\u003e\n\n  \u003capplication\n    android:name=\".MainApplication\"\n    android:allowBackup=\"true\"\n    android:label=\"@string/app_name\"\n    android:icon=\"@mipmap/ic_launcher\"\n    android:theme=\"@style/AppTheme\"\u003e\n\n    \u003c!-- react-native-background-geolocation-firebase licence --\u003e\n+     \u003cmeta-data android:name=\"com.transistorsoft.firebaseproxy.license\" android:value=\"YOUR_LICENCE_KEY_HERE\" /\u003e\n    .\n    .\n    .\n  \u003c/application\u003e\n\u003c/manifest\u003e\n```\n\n## :large_blue_diamond: Using the plugin ##\n\n```javascript\nimport BackgroundGeolocationFirebase from \"react-native-background-geolocation-firebase\";\n```\n\n## :large_blue_diamond: Example\n\n```javascript\n\nimport BackgroundGeolocation from \"react-native-background-geolocation\";\nimport BackgroundGeolocationFirebase from \"react-native-background-geolocation-firebase\";\n.\n.\n.\nfunction App(): React.JSX.Element {\n  \n  React.useEffect(() =\u003e {\n    // Configure BackgroundGeolocation Firebase adapter.\n    BackgroundGeolocationFirebase.configure({\n      locationsCollection: \"locations\",\n      geofencesCollection: \"geofences\"\n    });\n\n    // Configure BackgroundGeolocation\n    const onLocation = BackgroundGeolocation.onLocation((location) =\u003e {\n      console.log('[onLocation] ', location);\n    });\n\n    BackgroundGeolocation.ready({\n      debug: true,\n      logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE\n    }).then((state) =\u003e {\n      console.log('- ready: ', state.enablede);\n      if (!state.enabled) {\n        BackgroundGeolocation.start();\n      }\n    })\n    return () =\u003e {\n      // Remove event-listeners.\n      onLocation.remove();\n    }\n  });\n}\n\n```\n\n## :large_blue_diamond: Firebase Functions\n\n`BackgroundGeolocation` will post its default \"Location Data Schema\" to your Firebase app.\n\n```json\n{\n  \"location\":{},\n  \"param1\": \"param 1\",\n  \"param2\": \"param 2\"\n}\n```\n\nYou should implement your own [Firebase Functions](https://firebase.google.com/docs/functions) to \"*massage*\" the incoming data in your collection as desired.  For example:\n\n```typescript\nimport * as functions from 'firebase-functions';\n\nexports.createLocation = functions.firestore\n  .document('locations/{locationId}')\n  .onCreate((snap, context) =\u003e {\n    const record = snap.data();\n\n    const location = record.location;\n\n    console.log('[data] - ', record);\n\n    return snap.ref.set({\n      uuid: location.uuid,\n      timestamp: location.timestamp,\n      is_moving: location.is_moving,\n      latitude: location.coords.latitude,\n      longitude: location.coords.longitude,\n      speed: location.coords.speed,\n      heading: location.coords.heading,\n      altitude: location.coords.altitude,\n      event: location.event,\n      battery_is_charging: location.battery.is_charging,\n      battery_level: location.battery.level,\n      activity_type: location.activity.type,\n      activity_confidence: location.activity.confidence,\n      extras: location.extras\n    });\n});\n\n\nexports.createGeofence = functions.firestore\n  .document('geofences/{geofenceId}')\n  .onCreate((snap, context) =\u003e {\n    const record = snap.data();\n\n    const location = record.location;\n\n    console.log('[data] - ', record);\n\n    return snap.ref.set({\n      uuid: location.uuid,\n      identifier: location.geofence.identifier,\n      action: location.geofence.action,\n      timestamp: location.timestamp,\n      latitude: location.coords.latitude,\n      longitude: location.coords.longitude,\n      extras: location.extras,\n    });\n});\n\n```\n\n## :large_blue_diamond: Configuration Options\n\n#### `@param {String} locationsCollection [locations]`\n\nThe collection name to post `location` events to.  Eg:\n\n```javascript\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/locations'\n});\n\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/users/123/locations'\n});\n\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/users/123/routes/456/locations'\n});\n\n```\n\n#### `@param {String} geofencesCollection [geofences]`\n\nThe collection name to post `geofence` events to.  Eg:\n\n```javascript\nBackgroundGeolocationFirebase.configure({\n  geofencesCollection: '/geofences'\n});\n\nBackgroundGeolocationFirebase.configure({\n  geofencesCollection: '/users/123/geofences'\n});\n\nBackgroundGeolocationFirebase.configure({\n  geofencesCollection: '/users/123/routes/456/geofences'\n});\n\n```\n\n\n#### `@param {Boolean} updateSingleDocument [false]`\n\nIf you prefer, you can instruct the plugin to update a *single document* in Firebase rather than creating a new document for *each* `location` / `geofence`.  In this case, you would presumably implement a *Firebase Function* to deal with updates upon this single document and store the location in some other collection as desired.  If this is your use-case, you'll also need to ensure you configure your `locationsCollection` / `geofencesCollection` accordingly with an even number of \"parts\", taking the form `/collection_name/document_id`, eg:\n\n```javascript\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/locations/latest'  // \u003c-- 2 \"parts\":  even\n});\n\n// or\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/users/123/routes/456/the_location'  // \u003c-- 4 \"parts\":  even\n});\n\n// Don't use an odd number of \"parts\"\nBackgroundGeolocationFirebase.configure({\n  locationsCollection: '/users/123/latest_location'  // \u003c-- 3 \"parts\": odd!!  No!\n});\n\n```\n\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2018 Chris Scott, Transistor Software\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransistorsoft%2Freact-native-background-geolocation-firebase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransistorsoft%2Freact-native-background-geolocation-firebase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransistorsoft%2Freact-native-background-geolocation-firebase/lists"}