From f6ae4aef8c6244b4e23f73bda06cac263b7dd70f Mon Sep 17 00:00:00 2001 From: Eugene Burmakin Date: Fri, 5 Apr 2024 22:20:12 +0200 Subject: [PATCH] Add changelog, version badge, and APPLICATION_HOST environment variable --- CHANGELOG.md | 22 ++++++++++++++++++++++ README.md | 17 ++++++++++++----- app/views/shared/_navbar.html.erb | 3 ++- config/environments/development.rb | 3 ++- dev-docker-entrypoint.sh | 2 +- docker-compose.yml | 2 ++ 6 files changed, 41 insertions(+), 8 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..73daaf10 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ + +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +## [0.1.5] - 2024-04-05 + +You can now specify the host of the application by setting the `APPLICATION_HOST` environment variable in the `docker-compose.yml` file. + +### Added + +- Added version badge to navbar +- Added APPLICATION_HOST environment variable to docker-compose.yml to allow user to specify the host of the application +- Added CHANGELOG.md to keep track of changes + +### Changed + +- Specified gem version in Docker entrypoint + +### Fixed diff --git a/README.md b/README.md index d70d5c7e..21bd4ea2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Dawarich is a self-hosted web application to replace Google Timeline (aka Google Location History). It allows you to import your location history from Google Maps Timeline and Owntracks, view it on a map and see some statistics, such as the number of countries and cities visited, and distance traveled. +You can find changelog [here](CHANGELOG.md). + ## Usage To track your location, install the [Owntracks app](https://owntracks.org/booklet/guide/apps/) on your phone and configure it to send location updates to your Dawarich instance. Currently, the app only supports [HTTP mode](https://owntracks.org/booklet/tech/http/). The url to send the location updates to is `http:///api/v1/points`. @@ -10,6 +12,10 @@ To import your Google Maps Timeline data, download your location history from [G ## Features +### Location Tracking + +You can track your location using the Owntracks app. + ### Location history You can view your location history on a map. @@ -34,11 +40,12 @@ Copy the contents of the `docker-compose.yml` file to your server and run `docke ## Environment variables -`MINIMUM_POINTS_IN_CITY` — minimum number of points in a city to consider it as a city visited, eg. `10` - -`MAP_CENTER` — default map center, e.g. `55.7558,37.6176` - -`TIME_ZONE` — time zone, e.g. `Europe/Berlin` +``` +MINIMUM_POINTS_IN_CITY — minimum number of points in a city to consider it as a city visited, eg. `10` +MAP_CENTER — default map center, e.g. `55.7558,37.6176` +TIME_ZONE — time zone, e.g. `Europe/Berlin` +APPLICATION_HOST — host of the application, e.g. `localhost` or `dawarich.example.com` +``` ## Screenshots diff --git a/app/views/shared/_navbar.html.erb b/app/views/shared/_navbar.html.erb index 4bd0a738..b3fe1a21 100644 --- a/app/views/shared/_navbar.html.erb +++ b/app/views/shared/_navbar.html.erb @@ -10,7 +10,8 @@
  • <%= link_to 'Imports', imports_url %>
    • - <%= link_to 'DaWarIch', root_path, class: 'btn btn-ghost normal-case text-xl mr-10'%> + <%= link_to 'DaWarIch', root_path, class: 'btn btn-ghost normal-case text-xl'%> +
    0.1.5