dawarich/README.md

# Dawarich

This is a Rails app that receives location updates from Owntracks and stores them in a database. It also provides a web interface to view the location history.

## Features

### Google Maps Timeline import

You can import your Google Maps Timeline data into Wardu.

### Location history

You can view your location history on a map.

## How to start the app locally

0. Install and start Docker
1. `make build` to build docker image and install all the dependencies (up to 5-10 mins)
2. `make setup` to install gems, setup database and create test records
3. `make start` to start the app

Press `Ctrl+C` to stop the app.

Dockerized with https://betterprogramming.pub/rails-6-development-with-docker-55437314a1ad

## Deployment

`make build_and_push version=0.0.5` to build and push the docker image to the registry

Then go to Portainer and update the service to use the new image

## 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`
Rename to Dawarich 2024-03-15 17:28:54 -04:00			`# Dawarich`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`This is a Rails app that receives location updates from Owntracks and stores them in a database. It also provides a web interface to view the location history.`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`## Features`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`### Google Maps Timeline import`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`You can import your Google Maps Timeline data into Wardu.`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`### Location history`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
Migrate from old template 2024-03-15 18:27:31 -04:00			`You can view your location history on a map.`
Initial Rails 7.0.2.3 template w/ rspec, tailwind, and devise user 2022-04-06 14:46:10 -04:00
			`## How to start the app locally`

			`0. Install and start Docker`
			1. `make build` to build docker image and install all the dependencies (up to 5-10 mins)
			2. `make setup` to install gems, setup database and create test records
			3. `make start` to start the app

			Press `Ctrl+C` to stop the app.

			`Dockerized with https://betterprogramming.pub/rails-6-development-with-docker-55437314a1ad`
Add details on how to deploy the app 2023-05-28 06:52:13 -04:00
Set default timespan equal to 1 month to date 2024-03-16 18:15:44 -04:00			`## Deployment`
Add details on how to deploy the app 2023-05-28 06:52:13 -04:00
Set default timespan equal to 1 month to date 2024-03-16 18:15:44 -04:00			`make build_and_push version=0.0.5` to build and push the docker image to the registry
Add details on how to deploy the app 2023-05-28 06:52:13 -04:00
Set default timespan equal to 1 month to date 2024-03-16 18:15:44 -04:00			`Then go to Portainer and update the service to use the new image`
Migrate from old template 2024-03-15 18:27:31 -04:00
Add StatCreatingJob to create stats asynchronously 2024-03-23 15:40:05 -04:00			`## 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`