Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit

Permalink
Remove android from geofire-java
Browse files Browse the repository at this point in the history
  • Loading branch information
@samtstern
samtstern committed Jun 11, 2019
1 parent c46ff33 commit d8c91b9
Show file tree
Hide file tree
Showing 4 changed files with 185 additions and 183 deletions.
168 changes: 168 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Contributing

We'd love for you to contribute to our source code and to make it even better than it is today! Here are the guidelines we'd like you to follow:

- [Code of Conduct](#coc)
- [Question or Problem?](#question)
- [Issues and Bugs](#issue)
- [Feature Requests](#feature)
- [Submission Guidelines](#submit)
- [Coding Rules](#rules)
- [Signing the CLA](#cla)

## <a name="coc"></a> Code of Conduct

As contributors and maintainers of the project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.

Communication through any of Firebase's channels (GitHub, StackOverflow, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.

If any member of the community violates this code of conduct, the maintainers of the project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.

If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at [email protected].

## <a name="question"></a> Got a Question or Problem?

If you have questions about how to use the project, please direct these to [StackOverflow][stackoverflow] and use the `firebase` tag. We are also available on GitHub issues.

If you feel that we're missing an important bit of documentation, feel free to
file an issue so we can help. Here's an example to get you started:

```
What are you trying to do or find out more about?
Where have you looked?
Where did you expect to find this information?
```

## <a name="issue"></a> Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an issue on this repository. Even better you can submit a Pull Request
with a fix.

See [below](#submit) for some guidelines.

## <a name="submit"></a> Submission Guidelines

### Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues. Providing the following information will increase the
chances of your issue being dealt with quickly:

* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
* **Motivation for or Use Case** - explain why this is a bug for you
* **Browsers and Operating System** - is this a problem with all browsers or only IE9?
* **Reproduce the Error** - provide a live example or an unambiguous set of steps.
* **Related Issues** - has a similar issue been reported before?
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit)

**If you get help, help others. Good karma rulez!**

Here's a template to get you started:

```
System information (OS, Device, etc):
What steps will reproduce the problem:
1.
2.
3.
What is the expected result?
What happens instead of that?
Code, logs, or screenshot that illustrate the problem:
```

### Submitting a Pull Request
Before you submit your pull request consider the following guidelines:

* Search for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort.
* Please sign our [Contributor License Agreement (CLA)](#cla) before
sending pull requests. We cannot accept code without this.
* Make your changes in a new git branch:

```shell
git checkout -b my-fix-branch master
```

* Create your patch, **including appropriate test cases**.
* Follow our [Coding Rules](#rules).
* Commit your changes using a descriptive commit message.

```shell
git commit -a
```
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Push your branch to GitHub:

```shell
git push origin my-fix-branch
```

* In GitHub, send a pull request to `master`.
* If we suggest changes then:
* Make the required updates.
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

```shell
git rebase master -i
git push origin my-fix-branch -f
```

That's it! Thank you for your contribution!
#### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
* Check out the master branch:
```shell
git checkout master -f
```
* Delete the local branch:
```shell
git branch -D my-fix-branch
```
* Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
## <a name="rules"></a> Coding Rules
We generally follow [Google's style guides][style-guide].

## <a name="cla"></a> Signing the CLA

Please sign our [Contributor License Agreement][google-cla] (CLA) before sending pull requests. For any code
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
*This guide was inspired by the [AngularJS contribution guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md).*
[google-cla]: https://cla.developers.google.com
[style-guide]: http://google.github.io/styleguide/
[stackoverflow]: http://stackoverflow.com/questions/tagged/firebase
87 changes: 17 additions & 70 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# GeoFire for Android/Java — Realtime location queries with Firebase
# GeoFire for Java — Realtime location queries with Firebase

[![Build Status](https://travis-ci.org/firebase/geofire-java.svg?branch=master)](https://travis-ci.org/firebase/geofire-java?branch=master)

GeoFire is an open-source library for Android/Java that allows you to store and query a
**Note** This library is only for _server side_ Java development. If you want to use GeoFire
in your Android application, see [`geofire-android`](https://github.com/firebase/geofire-android).

GeoFire is an open-source library for Java 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 querying keys within a given geographic
area - all in realtime.

GeoFire uses the [Firebase](https://www.firebase.com/?utm_source=geofire-java) database for
GeoFire uses the [Firebase Realtime Database](https://firebase.google.com/products/realtime-database/) 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.

A compatible GeoFire client is also available for [Objective-C](https://github.com/firebase/geofire-objc)
and [JavaScript](https://github.com/firebase/geofire-js).
GeoFire clients are also available for other languages:

For a full example of an application using GeoFire to display realtime transit data, see the
[SFVehicles](https://github.com/firebase/geofire-java/tree/master/examples/SFVehicles) example in
Android app in this repo.
* [Android](https://github.com/firebase/geofire-android)
* [Objective-C (iOS)](https://github.com/firebase/geofire-objc)
* [JavaScript (Web)](https://github.com/firebase/geofire-js)

### Integrating GeoFire with your data

Expand Down Expand Up @@ -57,28 +59,14 @@ here](https://github.com/firebase/geofire-js/blob/master/examples/securityRules/
and [read our docs for more information about indexing your data](https://www.firebase.com/docs/security/guide/indexing-data.html).


## Including GeoFire in your project Android/Java

In order to use GeoFire in your project, you need to [add the Firebase Android
SDK](https://firebase.google.com/docs/android/setup). After that you can include GeoFire with one of the choices below.
## Including GeoFire in your Java project

Note that after version `1.1.1` the artifact `com.firebase:geofire` is no
longer updated and has been replaced by the separate Android and Java
artifacts as described below.
In order to use GeoFire in your project, you need to [add the Firebase Admin
SDK](https://firebase.google.com/docs/admin/setup). After that you can include GeoFire with one of the choices below.

### Gradle

Add a dependency for GeoFire to your `gradle.build` file.

For Android applications:

```groovy
dependencies {
compile 'com.firebase:geofire-android:2.3.1'
}
```

For non-Android Java applications:
Add a dependency for GeoFire to your `build.gradle` file:

```groovy
dependencies {
Expand All @@ -89,19 +77,7 @@ dependencies {

### Maven

GeoFire also works with Maven.

For Android applications:

```xml
<dependency>
<groupId>com.firebase</groupId>
<artifactId>geofire-android</artifactId>
<version>2.3.1</version>
</dependency>
```

For non-Android Java applications:
Add a dependency for GeoFire to your `pom.xml` file:

```xml
<dependency>
Expand All @@ -111,22 +87,7 @@ For non-Android Java applications:
</dependency>
```

### Jar-File

You can also download the jar file from the latest release on the [releases
page](https://github.com/firebase/geofire-java/releases).


## Getting Started with Firebase

GeoFire requires the Firebase database in order to store location data. You can [sign up here for a free
account](https://console.firebase.google.com/).


## Quickstart

This is a quickstart on how to use GeoFire's core features. There is also a
[full API reference available online](https://geofire-java.firebaseapp.com/docs/).
## Usage

### GeoFire

Expand Down Expand Up @@ -338,24 +299,10 @@ the query to the new visible map area after a user scrolls.


## Deployment

- In your local environment set `$BINTRAY_USER` and `$BINTRAY_KEY` to your
Bintray.com username and API key.
- Checkout and update the master branch.
- Run `./release.sh` to build and deploy.
- On bintray.com, publish the draft artifacts.
- Update [firebase-versions](https://github.com/firebase/firebase-clients/blob/master/versions/firebase-versions.json) with the changelog from this version
- tweet the release

## API Reference

[A full API reference is available here](https://geofire-java.firebaseapp.com/docs/).


## Contributing

If you want to contribute to GeoFire for Java, clone the repository
and just start making pull requests.

```bash
git clone https://github.com/firebase/geofire-java.git
```
Loading

0 comments on commit d8c91b9

Please sign in to comment.