hypertrack/live-app-android

Build live location sharing in your Android app https://play.google.com/store/apps/details?id=com.hypertrack.live

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.hypertrack:hypertrack-live-android:'
	}

	dependencies {
		implementation("com.github.hypertrack:hypertrack-live-android:")
	}

	<dependency>
	    <groupId>com.github.hypertrack</groupId>
	    <artifactId>hypertrack-live-android</artifactId>
	    <version></version>
	</dependency>


                            
    libraryDependencies += "com.github.hypertrack" % "hypertrack-live-android" % ""


                            
    :dependencies [[com.github.hypertrack/hypertrack-live-android ""]]

Readme

Live Location Sharing

This open source app for Live Location Sharing is built with HyperTrack. Developers can now build live location sharing into their apps within minutes by using HyperTrack Live source code. For iOS, refer to our open source iOS repository.

HyperTrack Live for Android is available on the Google Play Store for use by users signed up with HyperTrack. HyperTrack Live for iOS is available on the public App Store.

👋 Read our blog post announcement to learn more about this sample app.

The app demonstrates a simple flow for users to share their live location with friends through their favorite messaging app when on the way to meet up. The convenient 23-character secure short-URL displays live location with accuracy, speed, bearing and recency. The view highlights the ongoing activity (walk, drive, stop, etc.). Device getting inactive due to permissions or other reasons, or disconnected due to unknown reasons is highlighted in the tracking experience. Battery charing and low battery states are flagged as well.

Live Location Sharing

The primary feature of Hypertrack Live is Live Location Sharing. Live Location Sharing is useful for:

Workforce productivity apps with messaging and customer support capabilities
Peer-to-peer marketplaces for goods and services
Ridesharing and carpooling apps
Consumer apps like messengers and social apps

It helps solve the user's anxiety of “where are you⁉️”.

Architecture

<details> <summary>Step by step process of communication:</summary>

User makes a request to go to destination at location X
- Prior to creating a trip to go to destination X, the user signs in into HyperTrack Live App using a HyperTrack account. HyperTrack Live App authenticates the user to Live App Backend and obtains a JWT auth token to access it. Live App Backend serves as a backend platform example for HyperTrack Live App to demonstrate the following:
  - Performs as HyperTrack Live App user management service. For this example, we use HyperTrack dashboard account user management as the way to perform HyperTrack Live App user management. You may wish to use your own user management setup for the app you are building.
  - Performs as HypeTrack Live App backend server performing HyperTrack APIs calls which require authentication via AccountId and SecretKey available in the setup page.
- Once the user picks a location in the app and creates a trip with a destination to it, HyperTrack Live App performs a call to Live App Backend with the JWT token from the above.
Create trip to destination at location X via Trips API
- Live App Backend uses HyperTrack Trips API to create a trip with destination X. In order to authenticate to use the API, Live App Backend uses AccountId and SecretKey.
Show trip route with ETA with live updates to the user
- HyperTrack Views SDK queries the new trip information and provides trip information to HyperTrack Live App user. In addition, HyperTrack Views SDK receives realtime updates from HyperTrack platform and provides them as callbacks to HyperTrack Live App.
User shares public short URL for the trip to locaton X with live ETA
- HyperTrack Live App user can share a publicly visible trip URL for the trip with anyone on the internet with a browser.
Short URL recipient tracks user with live ETA to destination at location X
- The recipient or multiple recipients of the publicly visible trip URL can view HyperTrack Live App user ETA and location in realtime.
User ends live location sharing
- HyperTrack Live App user may end the trip upon reaching the destination. HyperTrack Live App notifies Live App Backend while authenticating with the JWT token from above.
Complete trip to destination at location X via Trips API
- Live App Backend uses HyperTrack Trips API to complete the trip with destination X.
- HyperTrack Trips API updates HyperTrack Views SDK in HyperTrack Live App with a completed trip summary to be displayed to the user. Additionally, recipients of publicly visible trip URL receive a live update about the trip completion and are displayed a completed trip summary as well.

</details>

How HyperTrack Live App uses HyperTrack Trips API

HyperTrack Live App uses HyperTrack Trips API to create and complete trips by using Live App Backend. Live App Backend allows to integrate with HyperTrack Trips API via backend server integration.

Once the trip is created in the HyperTrack Live App, the Live App calls Live App Backend which in turn creates a trip via Trips API. Once the trip is completed, the app notifies Live App Backend, which in turn calls HyperTrack Trips API to complete the trip.

Usage

To use this app

Clone this repository

$ git clone https://github.com/hypertrack/live-app-android.git

$ cd live-app-android

Register app in Firebase

Goto <a href="https://console.firebase.google.com/">Firebase Console</a> and create test project (or you can reuse existing one)
<img src="https://github.com/hypertrack/quickstart-android/blob/master/Images/add-app-to-test-project.png?raw=true"/>
Register new Android application using com.hypertrack.live package name.
<img src="images/register-app-in-firebase.png"/>
Download google-services.json file and copy it to app/ folder.
<img src="images/download-google-config.png"/>

Run app on device

Go through one-time registration flow in the app.

Finish setup

Verify your email and proceed to <a href="https://dashboard.hypertrack.com/setup#server_device_communication">setup page</a>. where you should fill FCM Key section in Android paragraph obtained from <i>Firebase Developer console > Project Settings (gear icon at top left) > Cloud Messaging tab.</i></p> <img src="https://github.com/hypertrack/quickstart-android/blob/master/Images/copy-server-key.png?raw=true"/>

Documentation

For detailed documentation of the APIs, customizations and what all you can build using HyperTrack, please visit the official docs.

Contribute

Feel free to clone, use, and contribute back via pull requests. We'd love to see your pull requests - send them in! Please use the issues tracker to raise bug reports and feature requests.

We are excited to see what Live Location feature you build in your app using this project. Do ping us at help@hypertrack.com once you build one, and we would love to feature your app on our blog!

Support

Join our Slack community for instant responses. You can also email us at help@hypertrack.com.