search

waarzitjenu / server

Back-end server (API) of waarzitje.nu.
European Union Public License 1.2
12 stars 4 forks source link
android android-app boltdb eupl golang golang-application gps-tracker gps-tracking hacktoberfest hacktoberfest2020 help-wanted location-tracker location-tracking openstreetmap osmand

readme

waarzitjenu/server

Waarzitje.nu is a basic application for submitting and retrieving live location updates. Originally focused on OsmAnd, but basically any application that supports REST could use it.

CI Build Status PkgGoDev GitHub go.mod Go version Go Report Card GitHub commit activity GitHub open issues GitHub closed issues Requirements Status License

The back-end (REST API) of this application is made with Go, the front-end (map interface) is made with modern Vue 3 and TypeScript. Because of its modular setup, it is possible to run the back-end, front-end or a combination of both. :tada:

OsmAnd with activated live tracking and the corresponding console output from the back-end

Image: OsmAnd app submitting location updates to the back-end, front-end retrieving the current location and showing it on a map. Learn how to set up OsmAnd.

Resources

Getting started

Please read the installation instructions to learn how to get started. It explains how to run the back-end, front-end or both, with and without Docker. :wink:

API Documentation

To learn more about the API and see some examples of using it, take a look at the API Documentation.

Contributing

The contribution guidelines document briefly explains how to contribute to this repository. Also consider taking a look at the open issues to know what needs to be done and the kan-ban board to see who's currently working on what.

License

The license this project uses is the EUPL v1.2 or later. See LICENSE.txt. Available in other languages as well.