Note that this unofficial fork of GeoFire-JS is maintained separately from the official GeoFire-JS library, and exists to support storing data on the GeoFire index as means to improve performance.
Do not store large amounts of data on the index as it will be accessed frequently during geospatial searches. Only store the minimum amount of data required to assist in displaying search results to your end users.
###Example use case: ####Restaurant search Your app provides a way for end users to find restaurants in their area. You may want to store the Restaurant name on the GeoFire index so that you can quickly display that information without having to do a secondary lookup to another path in your Firebase forge.
GeoFire is an open-source library that allows you to store and query a set of keys based on their geographic location. At its heart, GeoFire simply stores locations with string keys. Its main benefit, however, is the possibility of retrieving only those keys within a given geographic area - all in realtime.
GeoFire uses the Firebase Realtime Database for data storage, allowing query results to be updated in realtime as they change. GeoFire selectively loads only the data near certain locations, keeping your applications light and responsive, even with extremely large datasets.
GeoFire is designed as a lightweight add-on to Firebase. To keep things simple, GeoFire stores data in its own format and its own location within your Firebase database. This allows your existing data format and Security Rules to remain unchanged while still providing you with an easy solution for geo queries.
A compatible GeoFire client is also available for Objective-C and Java.
In order to use GeoFire in your project, you need to include the following files in your HTML:
<!-- Firebase -->
<script src="https://www.gstatic.com/firebasejs/3.7.0/firebase.js"></script>
<!-- GeoFire -->
<script src="https://cdn.firebase.com/libs/geofire/4.1.2/geofire.min.js"></script>Use the URL above to download both the minified and non-minified versions of GeoFire from the Firebase CDN. You can also download them from the releases page of this GitHub repository.
You can also install GeoFire via npm or Bower. If downloading via npm, you will have to install Firebase separately (because it is a peer dependency to GeoFire):
$ npm install geofire firebase --saveOn Bower, the Firebase dependency will be downloaded automatically:
$ bower install geofire --saveYou can find a full list of our demos and view the code for each of them in the examples directory of this repository. The examples cover some of the common use cases for GeoFire and explain how to protect your data using the Firebase Database Security Rules.
Assume you are building an app to rate bars and you store all information for a bar, e.g. name,
business hours and price range, at /bars/<bar-id>. Later, you want to add the possibility for
users to search for bars in their vicinity. This is where GeoFire comes in. You can store the
location for each bar using GeoFire, using the bar IDs as GeoFire keys. GeoFire then allows you to
easily query which bar IDs (the keys) are nearby. To display any additional information about the
bars, you can load the information for each bar returned by the query at /bars/<bar-id>.
Using an older version of GeoFire and want to upgrade to the latest version? Check out our migration guides to find out how!
If you'd like to contribute to GeoFire, please first read through our contribution guidelines. Local setup instructions are available here.