classicvalues / geofire-js

GeoFire for JavaScript - Realtime location queries with Firebase

GeoFire for JavaScript

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 Realtime Database. This allows your existing data format and Security Rules to remain unchanged while still providing you with an easy solution for geo queries.

If you're looking to use this library with Cloud Firestore, see the documentation on implementing geoqueries on Firestore.

GeoFire is designed as a lightweight add-on to Firebase. To keep things simple, GeoFire stores data

A compatible GeoFire client is also available for Objective-C and Java.

Table of Contents

• Add GeoFire to your project
• Documentation
• Examples
• Release Notes
• Migration Guides
• Contributing

Add GeoFire to your project

The Firebase JS SDK is a peer dependency of GeoFire. Run the following command to install both libraries:

$ npm install geofire firebase --save

HTML

Alternatively, 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. Then, deploy it to Hosting in your Firebase project.

<!-- Firebase -->
<script src="https://www.gstatic.com/firebasejs/8.0.1/firebase-app.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.0.1/firebase-database.js"></script>

<!-- GeoFire (TODO: substitute in your own project id)-->
<script src="https://my-firebase-project.web.app/geofire-5.0.1.min.js"></script>

Bower

If you use Bower, the Firebase dependency will be downloaded automatically:

$ bower install geofire --save

Documentation

• API Reference

Examples

You 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.

Example Usage

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>.

Migration Guides

Using an older version of GeoFire and want to upgrade to the latest version? Check out our migration guides to find out how!

Contributing

If you'd like to contribute to GeoFire, please first read through our contribution guidelines. Local setup instructions are available here.