This repository contains the documentation. The reason for keeping all documentation in one place is have a better overview of the project. It makes it possible to publish documentation on GitHub pages or elsewhere.
Waarzitje.nu is an open source location tracker, built in a modern way. The project was originally focused on retrieving location updates from the OsmAnd app on Android and iOS, which could be saved and shared. This project has been part of Hacktoberfest 2020, and several useful additions have been made by Hacktoberfest participants. A database has been added, so it keeps location tracks instead of the last known location only, support for TLS has been added, configuration via a single file and an interface to show the location on a map. In other words, participating in Hacktoberfest was very successful and has brought this project to new heights.
Image: OsmAnd app submitting location updates to the back-end via the API. The current location is shown on a map by the Vue-based front-end application. Learn how to set up OsmAnd
From a general perspective, this project has been split into the back-end, middleware in the form of an API and a front-end interface.
waarzitjenu/database is the Go module providing the database functions.
waarzitjenu/auth is the Go module providing the authentication functions.
waarzitjenu/server is the API interface. This Go application is the middleware between the front-end. It depends on the Go back-end modules. To learn more about the API and see some examples of using it, take a look at the API Documentation.
waarzitjenu/map is the map interface. It is made with modern Vue 3 + TypeScript. It depends on the API to fetch location data and show it on the map.
All documentation is kept in this repository. Alongside the documentation in this repository, Go also generates its own documentation, which is published on GoDoc.org. Each individual repository includes a link to the automatically generated documentation.
The contribution guidelines document briefly explains how to contribute to this repository. Also consider taking a look at the open issues of a repository to know what needs to be done. There's also a global, automated kan-ban board to see who's currently working on what.
The license this project uses is the EUPL v1.2 or later. Please refer to the LICENSE file. Available in other languages as well.