Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/firebase/geofire-js

GeoFire for JavaScript - Realtime location queries with Firebase
https://github.com/firebase/geofire-js

Last synced: 3 days ago
JSON representation

GeoFire for JavaScript - Realtime location queries with Firebase

Host: GitHub
URL: https://github.com/firebase/geofire-js
Owner: firebase
License: mit
Created: 2013-09-25T23:27:26.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2024-11-18T20:55:19.000Z (24 days ago)
Last Synced: 2024-12-03T05:06:29.575Z (10 days ago)
Language: TypeScript
Homepage:
Size: 5.69 MB
Stars: 1,447
Watchers: 106
Forks: 347
Open Issues: 57
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-firebase - GeoFire for WEB - An open-source library for the Firebase Realtime Database that adds support for geospatial querying. (Helpers)
awesome-firebase - GeoFire for JavaScript - Firebase를 사용한 실시간 위치 쿼리 라이브러리입니다. (웹)
awesome-starred - firebase/geofire-js - GeoFire for JavaScript - Realtime location queries with Firebase (others)

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)

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](https://firebase.google.com/docs/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](https://firebase.google.com/docs/firestore/solutions/geoqueries).

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](https://github.com/firebase/geofire-objc)
and [Java](https://github.com/firebase/geofire-java).

## Table of Contents

* [Add GeoFire to your project](#add-geofire-to-your-project)
* [Documentation](#documentation)
* [Examples](#examples)
* [Release Notes](https://github.com/firebase/geofire-js/releases)
* [Migration Guides](#migration-guides)
* [Contributing](#contributing)

## Add GeoFire to your project

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

```bash
$ 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](https://github.com/firebase/geofire-js/releases). Then, deploy it to Hosting in your Firebase project.

```html

```

### Bower

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

```bash
$ bower install geofire --save
```

## Documentation

* [API Reference](docs/reference.md)

## Examples

You can find a full list of our demos and view the code for each of them in the
[examples directory](examples/) 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](https://firebase.google.com/docs/database/security/).

### 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/`. 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/`.

## Migration Guides

Using an older version of GeoFire and want to upgrade to the latest version? Check out our
[migration guides](docs/migration.md) to find out how!

## Contributing

If you'd like to contribute to GeoFire, please first read through our [contribution
guidelines](.github/CONTRIBUTING.md). Local setup instructions are available [here](.github/CONTRIBUTING.md#local-setup).

[gh-actions]: https://github.com/firebase/geofire-js/actions
[gh-actions-badge]: https://github.com/firebase/geofire-js/workflows/CI%20Tests/badge.svg

## License