{"id":13469698,"url":"https://github.com/firebase/geofire-js","last_synced_at":"2025-05-13T18:10:20.880Z","repository":{"id":400921,"uuid":"13108106","full_name":"firebase/geofire-js","owner":"firebase","description":"GeoFire for JavaScript - Realtime location queries with Firebase","archived":false,"fork":false,"pushed_at":"2025-02-18T18:32:35.000Z","size":6065,"stargazers_count":1444,"open_issues_count":59,"forks_count":348,"subscribers_count":105,"default_branch":"master","last_synced_at":"2025-04-25T15:48:38.328Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/firebase.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2013-09-25T23:27:26.000Z","updated_at":"2025-04-14T10:47:43.000Z","dependencies_parsed_at":"2023-07-05T14:47:48.047Z","dependency_job_id":"3ea60f22-29a6-4994-9c83-605ee4daee8b","html_url":"https://github.com/firebase/geofire-js","commit_stats":{"total_commits":445,"total_committers":31,"mean_commits":14.35483870967742,"dds":"0.39101123595505616","last_synced_commit":"df5d7b863f47cd583685ea7bed75d71fd5f38b56"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firebase%2Fgeofire-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firebase%2Fgeofire-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firebase%2Fgeofire-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firebase%2Fgeofire-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firebase","download_url":"https://codeload.github.com/firebase/geofire-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254000854,"owners_count":21997442,"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":[],"created_at":"2024-07-31T15:01:51.387Z","updated_at":"2025-05-13T18:10:20.854Z","avatar_url":"https://github.com/firebase.png","language":"TypeScript","readme":"# GeoFire for JavaScript [![Actions Status][gh-actions-badge]][gh-actions] [![Coverage Status](https://coveralls.io/repos/github/firebase/geofire-js/badge.svg?branch=master)](https://coveralls.io/github/firebase/geofire-js?branch=master) [![Version](https://badge.fury.io/gh/firebase%2Fgeofire-js.svg)](http://badge.fury.io/gh/firebase%2Fgeofire-js)\n\nGeoFire is an open-source library that allows you to store and query a set of keys based on their\ngeographic location. At its heart, GeoFire simply stores locations with string keys. Its main\nbenefit, however, is the possibility of retrieving only those keys within a given geographic\narea - all in realtime.\n\nGeoFire uses the [Firebase Realtime Database](https://firebase.google.com/docs/database/) for data\nstorage, allowing query results to be updated in realtime as they change. GeoFire *selectively loads\nonly the data near certain locations, keeping your applications light and responsive*, even with\nextremely large datasets.\n\nGeoFire is designed as a lightweight add-on to Firebase. To keep things simple, GeoFire stores data\nin its own format and its own location within your Firebase Realtime Database. This allows your existing data\nformat and Security Rules to remain unchanged while still providing you with an easy solution for geo\nqueries.\n\nIf you're looking to use this library with **Cloud Firestore**, see the documentation on \n[implementing geoqueries on Firestore](https://firebase.google.com/docs/firestore/solutions/geoqueries).\n\nGeoFire is designed as a lightweight add-on to Firebase. To keep things simple, GeoFire stores data\n\nA compatible GeoFire client is also available for [Objective-C](https://github.com/firebase/geofire-objc)\nand [Java](https://github.com/firebase/geofire-java).\n\n## Table of Contents\n\n* [Add GeoFire to your project](#add-geofire-to-your-project)\n* [Documentation](#documentation)\n* [Examples](#examples)\n* [Release Notes](https://github.com/firebase/geofire-js/releases)\n* [Migration Guides](#migration-guides)\n* [Contributing](#contributing)\n\n## Add GeoFire to your project\n\nThe Firebase JS SDK is a peer dependency of GeoFire. Run the following command to install both libraries:\n\n```bash\n$ npm install geofire firebase --save\n```\n\n### HTML\n\nAlternatively, you can include GeoFire in your HTML. To do so download a minified or non-minified version of GeoFire from the [releases page of this GitHub repository](https://github.com/firebase/geofire-js/releases). Then, deploy it to Hosting in your Firebase project. \n\n```html\n\u003c!-- Firebase --\u003e\n\u003cscript src=\"https://www.gstatic.com/firebasejs/8.0.1/firebase-app.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"https://www.gstatic.com/firebasejs/8.0.1/firebase-database.js\"\u003e\u003c/script\u003e\n\n\u003c!-- GeoFire (TODO: substitute in your own project id)--\u003e\n\u003cscript src=\"https://my-firebase-project.web.app/geofire-5.0.1.min.js\"\u003e\u003c/script\u003e\n```\n\n### Bower\n\nIf you use Bower, the Firebase dependency will be downloaded automatically:\n\n```bash\n$ bower install geofire --save\n```\n\n## Documentation\n\n* [API Reference](docs/reference.md)\n\n## Examples\n\nYou can find a full list of our demos and view the code for each of them in the\n[examples directory](examples/) of this repository. The examples cover some of the common use\ncases for GeoFire and explain how to protect your data using the\n[Firebase Database Security Rules](https://firebase.google.com/docs/database/security/).\n\n### Example Usage\n\nAssume you are building an app to rate bars and you store all information for a bar, e.g. name,\nbusiness hours and price range, at `/bars/\u003cbar-id\u003e`. Later, you want to add the possibility for\nusers to search for bars in their vicinity. This is where GeoFire comes in. You can store the\nlocation for each bar using GeoFire, using the bar IDs as GeoFire keys. GeoFire then allows you to\neasily query which bar IDs (the keys) are nearby. To display any additional information about the\nbars, you can load the information for each bar returned by the query at `/bars/\u003cbar-id\u003e`.\n\n## Migration Guides\n\nUsing an older version of GeoFire and want to upgrade to the latest version? Check out our\n[migration guides](docs/migration.md) to find out how!\n\n## Contributing\n\nIf you'd like to contribute to GeoFire, please first read through our [contribution\nguidelines](.github/CONTRIBUTING.md). Local setup instructions are available [here](.github/CONTRIBUTING.md#local-setup).\n\n[gh-actions]: https://github.com/firebase/geofire-js/actions\n[gh-actions-badge]: https://github.com/firebase/geofire-js/workflows/CI%20Tests/badge.svg\n\n## License\n\n© Google, 2022. Licensed under [The MIT License](LICENSE).\n","funding_links":[],"categories":["TypeScript","Helpers","others","웹"],"sub_categories":["Reference"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirebase%2Fgeofire-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirebase%2Fgeofire-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirebase%2Fgeofire-js/lists"}