FitTrackee/README.md

# FitTrackee
**A simple self-hosted workout/activity tracker.**  

[![PyPI version](https://img.shields.io/pypi/v/fittrackee.svg)](https://pypi.org/project/fittrackee/) 
[![Python Version](https://img.shields.io/badge/python-3.7+-brightgreen.svg)](https://python.org)
[![Flask Version](https://img.shields.io/badge/flask-1.1-brightgreen.svg)](http://flask.pocoo.org/) 
[![code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black) 
[![type check: mypy](https://img.shields.io/badge/type%20check-mypy-blue)](http://mypy-lang.org/)  
[![React Version](https://img.shields.io/badge/react-17.0-brightgreen.svg)](https://reactjs.org/) 
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)  
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d)](https://www.codacy.com/app/SamR1/FitTrackee)
[![pipeline status](https://gitlab.com/SamR1/FitTrackee/badges/master/pipeline.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master)
[![coverage report](https://gitlab.com/SamR1/FitTrackee/badges/master/coverage.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master) <sup><sup>1</sup></sup>

---

This web application allows you to track your outdoor activities (workouts) from gpx files and keep your data on your own server.  
No mobile app is developed yet, but several existing mobile apps can store workouts data locally and export them into a gpx file.  
Examples for Android (non-exhaustive list):  
* [Runner Up](https://github.com/jonasoreland/runnerup) (GPL v3)  
* [ForRunners](https://gitlab.com/brvier/ForRunners) (GPL v3)  
* [OpenTracks](https://github.com/OpenTracksApp/OpenTracks) (Apache License)  
* [FitoTrack](https://codeberg.org/jannis/FitoTrack) (GPL v3)  

Maps are displayed using [Open Street Map](https://www.openstreetmap.org).  
It is also possible to add a workout without a gpx file.

**Still under heavy development (some features may be unstable).**  
(see [issues](https://github.com/SamR1/FitTrackee/issues) and [documentation](https://samr1.github.io/FitTrackee) for more information)  

![FitTrackee Dashboard Screenshot](https://samr1.github.io/FitTrackee/_images/fittrackee_screenshot-01.png)

---

Notes:  
_1. Test coverage: only for Python API_
'mpwo' renamed to 'FitTrackee' 2018-06-07 15:40:22 +02:00			`# FitTrackee`
README.me update + minor changes 2018-05-30 17:48:58 +02:00			`A simple self-hosted workout/activity tracker.`
dashboard - first version 2017-04-02 20:12:15 +02:00
update README.md 2021-01-03 10:25:05 +01:00			`[![PyPI version](https://img.shields.io/pypi/v/fittrackee.svg)](https://pypi.org/project/fittrackee/)`
Update README.md 2020-07-15 17:25:55 +02:00			`[![Python Version](https://img.shields.io/badge/python-3.7+-brightgreen.svg)](https://python.org)`
update Flask version on README.md 2019-07-14 12:14:51 +02:00			`[![Flask Version](https://img.shields.io/badge/flask-1.1-brightgreen.svg)](http://flask.pocoo.org/)`
update README.md 2019-08-31 14:17:47 +02:00			`[![code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)`
update README.md 2021-01-03 09:54:36 +01:00			`[![type check: mypy](https://img.shields.io/badge/type%20check-mypy-blue)](http://mypy-lang.org/)`
update README.md 2020-12-30 10:13:42 +01:00			`[![React Version](https://img.shields.io/badge/react-17.0-brightgreen.svg)](https://reactjs.org/)`
update README.md 2019-08-31 14:17:47 +02:00			`[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)`
Client: refactor (wip) 2018-06-12 11:47:01 +02:00			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d)](https://www.codacy.com/app/SamR1/FitTrackee)`
update README.md 2021-01-03 09:54:36 +01:00			`[![pipeline status](https://gitlab.com/SamR1/FitTrackee/badges/master/pipeline.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master)`
			`[![coverage report](https://gitlab.com/SamR1/FitTrackee/badges/master/coverage.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master) <sup><sup>1</sup></sup>`
API: minor fix 2017-12-17 12:07:25 +01:00
README.me update + minor changes 2018-05-30 17:48:58 +02:00			`---`

API - replace 'Activity' with 'Workout' - #58 2021-01-10 11:16:43 +01:00			`This web application allows you to track your outdoor activities (workouts) from gpx files and keep your data on your own server.`
README.md update 2018-07-04 14:29:27 +02:00			`No mobile app is developed yet, but several existing mobile apps can store workouts data locally and export them into a gpx file.`
Docs - remove proprietary app from list of examples of tracking apps 2021-06-06 11:30:51 +02:00			`Examples for Android (non-exhaustive list):`
README.me update + minor changes 2018-05-30 17:48:58 +02:00			`* [Runner Up](https://github.com/jonasoreland/runnerup) (GPL v3)`
update README.md to add link to documentation - #21 2019-07-14 19:54:44 +02:00			`* [ForRunners](https://gitlab.com/brvier/ForRunners) (GPL v3)`
update documentation 2020-07-15 17:19:37 +02:00			`* [OpenTracks](https://github.com/OpenTracksApp/OpenTracks) (Apache License)`
			`* [FitoTrack](https://codeberg.org/jannis/FitoTrack) (GPL v3)`
Update README.md 2018-05-30 18:40:24 +02:00
Update README.md 2018-06-15 11:37:30 +02:00			`Maps are displayed using [Open Street Map](https://www.openstreetmap.org).`
			`It is also possible to add a workout without a gpx file.`
README.me update + minor changes 2018-05-30 17:48:58 +02:00
update documentation 2020-09-19 13:56:14 +02:00			`Still under heavy development (some features may be unstable).`
update README.md to add link to documentation - #21 2019-07-14 19:54:44 +02:00			`(see [issues](https://github.com/SamR1/FitTrackee/issues) and [documentation](https://samr1.github.io/FitTrackee) for more information)`
README.me update + minor changes 2018-05-30 17:48:58 +02:00
update documentation 2020-09-19 13:56:14 +02:00			`![FitTrackee Dashboard Screenshot](https://samr1.github.io/FitTrackee/_images/fittrackee_screenshot-01.png)`
README.md update 2018-06-07 22:57:58 +02:00
API: test coverage on codacy 2018-05-12 18:21:00 +02:00			`---`

			`Notes:`
			`_1. Test coverage: only for Python API_`