API - replace 'Activity' with 'Workout' - #58
This commit is contained in:
@ -1,17 +0,0 @@
|
||||
Activities
|
||||
##########
|
||||
|
||||
.. autoflask:: fittrackee:create_app()
|
||||
:endpoints:
|
||||
activities.get_activities,
|
||||
activities.get_activity,
|
||||
activities.get_activity_gpx,
|
||||
activities.get_activity_chart_data,
|
||||
activities.get_segment_chart_data,
|
||||
activities.get_segment_gpx,
|
||||
activities.get_map,
|
||||
activities.get_map_tile,
|
||||
activities.post_activity,
|
||||
activities.post_activity_no_gpx,
|
||||
activities.update_activity,
|
||||
activities.delete_activity
|
@ -5,10 +5,10 @@ API documentation
|
||||
:maxdepth: 2
|
||||
:caption: Endpoints:
|
||||
|
||||
activities
|
||||
auth
|
||||
configuration
|
||||
records
|
||||
sports
|
||||
stats
|
||||
users
|
||||
workouts
|
||||
|
@ -3,6 +3,6 @@ Statistics
|
||||
|
||||
.. autoflask:: fittrackee:create_app()
|
||||
:endpoints:
|
||||
stats.get_activities_by_time,
|
||||
stats.get_activities_by_sport,
|
||||
stats.get_workouts_by_time,
|
||||
stats.get_workouts_by_sport,
|
||||
stats.get_application_stats
|
||||
|
17
docs/_sources/api/workouts.rst.txt
Normal file
17
docs/_sources/api/workouts.rst.txt
Normal file
@ -0,0 +1,17 @@
|
||||
Workouts
|
||||
##########
|
||||
|
||||
.. autoflask:: fittrackee:create_app()
|
||||
:endpoints:
|
||||
workouts.get_workouts,
|
||||
workouts.get_workout,
|
||||
workouts.get_workout_gpx,
|
||||
workouts.get_workout_chart_data,
|
||||
workouts.get_segment_chart_data,
|
||||
workouts.get_segment_gpx,
|
||||
workouts.get_map,
|
||||
workouts.get_map_tile,
|
||||
workouts.post_workout,
|
||||
workouts.post_workout_no_gpx,
|
||||
workouts.update_workout,
|
||||
workouts.delete_workout
|
@ -25,7 +25,7 @@ Administration
|
||||
|
||||
- **Sports**
|
||||
|
||||
- enable or disable a sport (a sport can be disabled even if activity with this sport exists)
|
||||
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
|
||||
|
||||
Account
|
||||
^^^^^^^
|
||||
@ -33,29 +33,29 @@ Account
|
||||
- A user can reset his password (*new in 0.3.0*)
|
||||
|
||||
|
||||
Activities/Workouts
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
- 6 sports supported:
|
||||
Workouts
|
||||
^^^^^^^^
|
||||
- 6 sports are supported:
|
||||
- Cycling (Sport)
|
||||
- Cycling (Transport)
|
||||
- Hiking
|
||||
- Montain Biking
|
||||
- Running
|
||||
- Walking
|
||||
- Dashboard with month calendar displaying activities and record. The week can start on Sunday or Monday (which can be changed in the user settings)
|
||||
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
|
||||
- An activity 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
|
||||
- Activity edition and deletion. User can add a note
|
||||
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user settings)
|
||||
- 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
|
||||
- User statistics
|
||||
- User records by sports:
|
||||
- average speed
|
||||
- farest distance
|
||||
- longest duration
|
||||
- maximum speed
|
||||
- Activities list and filter
|
||||
- Workours list and filter
|
||||
|
||||
.. note::
|
||||
for now, only the owner of the activity can see the activity.
|
||||
for now, only the owner of the workout can see it.
|
||||
|
||||
Translations
|
||||
^^^^^^^^^^^^
|
||||
@ -69,16 +69,16 @@ Dashboard
|
||||
:alt: FitTrackee Dashboard
|
||||
|
||||
|
||||
Activity/workout detail
|
||||
Workout detail
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. figure:: _images/fittrackee_screenshot-02.png
|
||||
:alt: FitTrackee Activity
|
||||
:alt: FitTrackee Workout
|
||||
|
||||
|
||||
Activities/workouts list
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Workouts list
|
||||
~~~~~~~~~~~~~
|
||||
.. figure:: _images/fittrackee_screenshot-03.png
|
||||
:alt: FitTrackee Activities
|
||||
:alt: FitTrackee Workouts
|
||||
|
||||
|
||||
Statistics
|
||||
|
@ -5,8 +5,8 @@
|
||||
FitTrackee
|
||||
==========
|
||||
|
||||
| This web application allows you to track your outdoor activities from
|
||||
gpx files and keep your data on your own server.
|
||||
| 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):
|
||||
|
Reference in New Issue
Block a user