Add the readme/roadmap.

This commit is contained in:
zontreck 2025-05-14 16:01:06 -07:00
parent dd9536f972
commit f98c639fa3

View file

@ -1,3 +1,21 @@
# TimeTracker
A flutter app designed for delivery driving. It tracks the GPS to show estimated total miles driven, and a map of where to. It also is designed to track the number of hours worked.
A flutter app designed for delivery driving. It tracks the GPS to show estimated total miles driven, and a map of where to. It also is designed to track the number of hours worked.
## How it works?
This app relies on the Location permissions.
When getting ready to drive, the driver should open the app, and hit the Engage button. It will then start to track. This should be done before driving.
Before starting a trip, the driver should then click on the new trip button. If there are multiple deliveries, each should be concluded with a 'End Stop' button.
When the trip has ended, the driver should 'End Trip', which goes back to just tracking the time and GPS, but not labeling each route.
## Why
I borrow the car from my grandparents, and need to closely track where I go for the miles, and how long I drive for. The app is designed to solve this problem by making it extremely convenient to not only display the data, but to then share it with my grandparents.
# Storage
The app does not store data locally, due to the way android permissions function. The app uses a public API on my server (api.zontreck.com) which will store all the data. When sharing the data, it generates a link to (timetrack.zontreck.com) which is a slimmed down version of this app and will only display the data in a readonly format.