Standort.live - Share your location with friends and family

❕ Prototype Status ❕

Introduction

"Standort" is a web application that makes it easy to share your location with friends and family. Your location remains private because sensitive information is only shared with people you trust using WebRTC.

This repository was created as part of a bachelor thesis in Geoinformatics at the Institute for Geoinformatics, University of Münster. The aim of the project is to ensure the reproducibility and traceability of the results for future research.

Installation

Requirements:

• Node.js 18.x
• NPM 9.

npm install

npm run build

Development

NOTE: Please run build every time something has changed in `packages'.

Run development mode:

npm run dev

Open http://localhost:5000 to open the web application.

Configuration

Environment variables for signaling service:

• SIGNALING_PORT: Listening port (Default: 4000).
• SIGNALING_API_KEY Restrict by an API key (Default: empty),

Environment variables for web application:

• VITE_SIGNALING_URL: Signaling Websocket URL (Default: ws://localhost:4000)
• VITE_SIGNALING_API_KEY: Signaling API key (Default: empty)

Copy the .env.sample to .env and customize your configuration.

Test

Run linter:

npm run lint

Run tests:

npm run test

Run tests with coverage (for CI/CD):

npm run test:coverage

Measure the application

See measurements/README.md for more information.

Declaration of Authorship

This software, in its version 0.1, has been solely developed by Noel Schnierer as part of the bachelor thesis with the title WebRTC for privacy enhancement: design, implementation and usability testing of a web-based peer-to-peer live location sharing application.