FitTrackee/docsrc/source/features.rst

124 lines
3.8 KiB
ReStructuredText
Raw Normal View History

2019-07-14 18:18:41 +02:00
Features
########
List
~~~~
2019-08-25 21:21:34 +02:00
2020-07-15 15:30:41 +02:00
Administration
^^^^^^^^^^^^^^
2020-09-19 13:56:14 +02:00
(*new in 0.3.0*)
2020-07-15 17:19:37 +02:00
- **Application**
The following parameters can be set:
2020-07-15 15:30:41 +02:00
2021-02-21 00:09:10 +01:00
- active users limit. If 0, registration is enabled (no limit defined)
2020-07-15 15:30:41 +02:00
- maximum size of uploaded files
- maximum size of zip archive
2021-02-21 00:09:10 +01:00
- maximum number of files in the zip archive. If an archive contains more files, only the configured number of files is processed, without raising errors.
.. warning::
Updating server configuration may be necessary to handle large files (like `nginx <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_ for instance).
2020-07-15 15:30:41 +02:00
2020-07-15 17:19:37 +02:00
- **Users**
2020-07-15 15:30:41 +02:00
- display users list and details
- edit a user to add/remove administration rights
- delete a user
2020-07-15 17:19:37 +02:00
- **Sports**
2020-07-15 15:30:41 +02:00
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
2019-08-25 21:21:34 +02:00
2021-11-12 19:25:31 +01:00
Account & preferences
^^^^^^^^^^^^^^^^^^^^^
2020-09-19 13:56:14 +02:00
- A user can create, update and deleted his account
- A user can reset his password (*new in 0.3.0*)
2021-11-12 19:25:31 +01:00
- A user can set language, timezone and first day of week.
- A user can set sport preferences (*new in 0.5.0*):
2021-11-13 12:20:35 +01:00
- change sport color (used for sport image and charts)
2021-11-12 19:25:31 +01:00
- can override stopped speed threshold (for next uploaded gpx files)
2021-11-13 12:20:35 +01:00
- disable/enable a sport.
.. note::
| If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user's workouts and the user can only change sport color.
| A disabled sport (by admin or user) will not appear in dropdown when **adding a workout**.
| A workout with a disabled sport will still be displayed in the application.
2020-09-19 13:56:14 +02:00
Workouts
^^^^^^^^
2021-11-06 21:26:02 +01:00
- 11 sports are supported:
2019-07-14 18:18:41 +02:00
- Cycling (Sport)
- Cycling (Transport)
- Hiking
2021-11-06 21:26:02 +01:00
- Mountain Biking
- Mountain Biking (Electric) (**new in 0.5.0**)
- Rowing (**new in 0.5.0**)
2019-07-14 18:18:41 +02:00
- Running
2021-11-06 21:26:02 +01:00
- Skiing (Alpine) (**new in 0.5.0**)
- Skiing (Cross Country) (**new in 0.5.0**)
- Trail (**new in 0.5.0**)
2019-07-14 18:18:41 +02:00
- Walking
2021-11-12 19:25:31 +01:00
- (*new in 0.5.0*) Stopped speed threshold used by `gpxpy <https://github.com/tkrajina/gpxpy>`_ is not the default one for the following sports (0.1 km/h instead of 1 km/h):
2021-11-11 17:33:30 +01:00
- Hiking
- Skiing (Cross Country)
- Trail
- Walking
2021-11-12 19:25:31 +01:00
.. note::
It can be overridden in user preferences.
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user preferences). The calendar displays up to 100 workouts.
- Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance).
- A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed.
- Workout edition and deletion. User can add a note.
2019-07-14 18:18:41 +02:00
- User statistics
- User records by sports:
- average speed
- farest distance
- longest duration
- maximum speed
2021-11-13 12:20:35 +01:00
- Workouts list and filter. Only sports with workouts are displayed in sport dropdown.
2019-07-14 18:18:41 +02:00
2020-07-15 17:19:37 +02:00
.. note::
2021-11-13 12:20:35 +01:00
For now, only the owner of the workout can see it.
2019-07-14 18:18:41 +02:00
2019-12-29 12:50:32 +01:00
Translations
^^^^^^^^^^^^
2021-11-12 19:25:31 +01:00
FitTrackee is available in English and French (which can be saved in the user preferences).
2019-12-29 12:50:32 +01:00
2019-07-14 18:18:41 +02:00
Dashboard
~~~~~~~~~
2020-01-31 14:23:09 +01:00
.. figure:: _images/fittrackee_screenshot-01.png
2019-07-14 18:18:41 +02:00
:alt: FitTrackee Dashboard
Workout detail
2019-07-14 18:18:41 +02:00
~~~~~~~~~~~~~~~~~~~~~~~
2020-01-31 14:23:09 +01:00
.. figure:: _images/fittrackee_screenshot-02.png
:alt: FitTrackee Workout
2019-07-14 18:18:41 +02:00
Workouts list
~~~~~~~~~~~~~
2020-01-31 14:23:09 +01:00
.. figure:: _images/fittrackee_screenshot-03.png
:alt: FitTrackee Workouts
2019-07-14 18:18:41 +02:00
Statistics
~~~~~~~~~~
2020-01-31 14:23:09 +01:00
.. figure:: _images/fittrackee_screenshot-04.png
2019-07-14 18:18:41 +02:00
:alt: FitTrackee Statistics
2020-07-15 15:30:41 +02:00
Administration
~~~~~~~~~~~~~~
.. figure:: _images/fittrackee_screenshot-05.png
:alt: FitTrackee Administration
2021-11-03 12:41:23 +01:00
.. figure:: _images/fittrackee_screenshot-06.png
:alt: FitTrackee Sports Administration