Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/waarzitjenu/server

Back-end server (API) of waarzitje.nu.
https://github.com/waarzitjenu/server

android android-app boltdb eupl golang golang-application gps-tracker gps-tracking hacktoberfest hacktoberfest2020 help-wanted location-tracker location-tracking openstreetmap osmand

Last synced: 3 months ago
JSON representation

Back-end server (API) of waarzitje.nu.

Awesome Lists containing this project

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](https://travis-ci.org/waarzitjenu/server.svg?branch=develop)](https://travis-ci.org/waarzitjenu/server)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/waarzitjenu/server)](https://pkg.go.dev/github.com/waarzitjenu/server)
[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/waarzitjenu/server?color=%2300aa00)](./go.mod)
[![Go Report Card](https://goreportcard.com/badge/github.com/waarzitjenu/server)](https://goreportcard.com/report/github.com/waarzitjenu/server)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/waarzitjenu/server?color=%2300aa00)](https://github.com/waarzitjenu/server/graphs/commit-activity)
[![GitHub open issues](https://img.shields.io/github/issues/waarzitjenu/server)](https://github.com/waarzitjenu/server/issues?q=is%3Aopen+is%3Aissue)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/waarzitjenu/server?color=%2300aa00)](https://github.com/waarzitjenu/server/issues?q=is%3Aissue+is%3Aclosed)
[![Requirements Status](https://requires.io/github/waarzitjenu/server/requirements.svg?branch=master)](https://requires.io/github/waarzitjenu/server/requirements/?branch=master)
[![License](https://img.shields.io/github/license/waarzitjenu/server?color=%2300aa00)](./LICENSE.txt)

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](./docs/tracking-example.png)

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][OsmAnd documentation].

---

## 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](LICENSE.txt). Available in [other languages](./LICENSE) as well.

[installation instructions]: ./docs/Installation/README.md "Installation Instructions"
[API Documentation]: ./docs/API/README.md "API Documentation"
[contribution guidelines]: ./docs/CONTRIBUTING.md "Contribution guidelines"
[open issues]: https://github.com/ricardobalk/go-osmand-tracker/issues "Open issues of go-osmand-tracker"
[kan-ban board]: https://github.com/ricardobalk/go-osmand-tracker/projects/1 "Who's working on what?"

[OsmAnd documentation]: ./docs/OsmAnd/README.md "How to set up OsmAnd"