Location Live API

This repo represents the backend interface of the Location Live mobile app, allowing users to provide their own, custom backend for increased security and privacy.

Any backend that passes the contract defined here will work with the mobile app.

Install

npm install -g location-live-api

Run

To test a custom backend, run:

location-live-api testServer <my-custom-backend-url>

For example:

>> location-live-api testServer -- https://locationlive.rexgarland.dev
✅ Server is up.
✅ Server can receive location updates.
✅ Server can send location updates.
✅ Server prevents one user from editing another user's location (aka spoofing).
✅ Location updates include correct timestamps.
🎯 Complete!

Library

You can also use this package as a library, which exports a small helper class to call your backend.

The code is very simple (check api.ts).

import {LocationLiveAPI} from "location-live-api";

const api = new LocationLiveAPI('<my-custom-backend-root-url>')

await api.sendLocationUpdate({
    username: 'some-unique-username',
    key: 'some-secret-key',
    location: {
        lat: 41.881944,
        lon: -87.627778
    }
});

const {location, timestamp} = await api.getLocation({
    username: 'some-unique-username',
})

Testing

This contract itself is tested by ensuring a known-good server passes, and a known-bad server fails. It's a basic sanity check, which you can run for yourself:

npm install
npm test

Contributing

The repo provides two things:

• a wrapper for calling a Location Live server: api.ts
• a simple contract to ensure that custom backends implement the correct behavior: contract.ts

The main goal is portability:

• All the code built to /dist should be runnable in the browser, node, or react native, for example.
• This package is imported by the mobile app to run an on-device healthcheck.
• It avoids unnecessary dependencies which may fail to load/run in a new environment.