example

Demo App

Fully-featured, Capacitor Background Geolocation demo application.

Installation

• First clone the plugin repo.

git clone https://github.com/transistorsoft/capacitor-background-geolocation.git
cd capacitor-background-geolocation

• Now compile the plugin's typescript source code.

npm install
npm run build

ℹ️ Ignore warning (!) this has been rewritten to undefined

• Now install the /example as you would any Capacitor app.

cd example
npm install

ionic build
npx cap sync

• Now run it:

ionic capacitor run android
ionic capacitor run ios

• The quickest way to see the plugin in-action is to boot the iOS simulator and simulate location with Freeway Drive.

• The demo is composed of three separate and independent sub-applications:

  • Hello World
  • Simple Map
  • Advanced (with complex settings screen and geofencing.)

🔷 Tracking Server

The demo app is configured to post locations to Transistor Software's demo server, which hosts a web-application for visualizing and filtering your tracking on a map.

• After booting the app the first time, you'll be asked to enter a unique "Tracking Server Username" (eg: Github username) so the plugin can post locations to tracker.transistorsoft.com.

⚠️ Make your username unique and known only to you — if every one uses "test", you'll never find your device!)

• You can view the plugin's tracking history by visiting http://tracker.transistorsoft.com/username.

Adding Geofences

The app implements a long-press event on the map. Simply tap & hold the map to initiate adding a geofence.

Enter an identifier, radius, notifyOnExit, notifyOnEntry.