kevinsivic/dawarich
1
0
Fork 0
mirror of https://github.com/Freika/dawarich.git synced 2026-01-10 01:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Eugene Burmakin 2024-03-24 20:33:49 +01:00
parent 705c7ca7a2
commit eafbbe0775
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,11 +2,17 @@
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.
## 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. The url to send the location updates to is `http://<your-dawarich-instance>/api/v1/points`.
To import your Google Maps Timeline data, download your location history from [Google Takeout](https://takeout.google.com/) and upload it to Dawarich.
## Features
### Google Maps Timeline import
### Import
You can import your Google Maps Timeline data into Wardu.
You can import your Google Maps Timeline data into Dawarich as well as Owntracks data.
### Location history
@ -14,20 +20,13 @@ 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
`docker-compose up` to start the app. The app will be available at `http://localhost:3000`.
Press `Ctrl+C` to stop the app.
Dockerized with https://betterprogramming.pub/rails-6-development-with-docker-55437314a1ad
## How to deploy the app
## 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
Copy the contents of the `docker-compose.yml` file to your server and run `docker-compose up`.
## Environment variables