update documentation

This commit is contained in:
Sam 2020-07-15 15:30:41 +02:00
parent 3be8783ee3
commit 404bf286ef
46 changed files with 473 additions and 212 deletions

View File

@ -1,5 +1,23 @@
# Change log # Change log
## Version 0.3.0 - Administration (2020/07/xx)
This version introduces some major changes:
- FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration))
Note: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)).
- in order to send emails, Redis is now a mandatory dependency
### Issues Closed
#### New Features
* [#50](https://github.com/SamR1/Fittrackee/issues/50) - A user can reset his password
* [#17](https://github.com/SamR1/Fittrackee/issues/17) - A user can delete his account
* [#15](https://github.com/SamR1/Fittrackee/issues/15) - Complete the administration
In this release 3 issues were closed.
## Version 0.2.5 - Fix and improvements (2020/01/31) ## Version 0.2.5 - Fix and improvements (2020/01/31)
### Misc ### Misc
@ -139,7 +157,7 @@ In this release 7 issues were closed.
- only activity owner can see his activity - only activity owner can see his activity
- no administration for now - no administration for now
➡️ more informations: see [wiki](https://github.com/SamR1/mpwo/wiki) and [current issues](https://github.com/SamR1/mpwo/issues) ➡️ more informations: see [documentation](https://samr1.github.io/FitTrackee/) and [current issues](https://github.com/SamR1/FitTrackee/issues)
### Issues Closed ### Issues Closed

View File

@ -85,10 +85,10 @@ run-client:
serve -s fittrackee_client/build -l 3000 >> serve.log 2>&1 serve -s fittrackee_client/build -l 3000 >> serve.log 2>&1
run-server: run-server:
cd fittrackee_api && $(GUNICORN) -b 127.0.0.1:5000 "fittrackee_api:create_app()" --error-logfile ../gunicorn-error.log cd fittrackee_api && $(GUNICORN) -b 127.0.0.1:5000 "fittrackee_api:create_app()" --error-logfile ../gunicorn.log
run-workers: run-workers:
$(FLASK) worker --processes=$(WORKERS_PROCESSES) >> workers.log 2>&1 $(FLASK) worker --processes=$(WORKERS_PROCESSES) >> dramatiq.log 2>&1
serve-python: serve-python:
$(FLASK) run --with-threads -h $(HOST) -p $(API_PORT) $(FLASK) run --with-threads -h $(HOST) -p $(API_PORT)

View File

@ -1 +1 @@
0.2.5-beta 0.3.0-beta

View File

@ -1,4 +1,4 @@
# Sphinx build info version 1 # Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e282ec0ee22254d2da5f1887ad2213c6 config: 57cf94c97f6ec96dcc19fd72f77a5fec
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7

Binary file not shown.

Before

Width:  |  Height:  |  Size: 599 KiB

After

Width:  |  Height:  |  Size: 598 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 539 KiB

After

Width:  |  Height:  |  Size: 541 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 205 KiB

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

View File

@ -1,5 +1,23 @@
# Change log # Change log
## Version 0.3.0 - Administration (2020/07/xx)
This version introduces some major changes:
- FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration))
Note: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)).
- in order to send emails, Redis is now a mandatory dependency
### Issues Closed
#### New Features
* [#50](https://github.com/SamR1/Fittrackee/issues/50) - A user can reset his password
* [#17](https://github.com/SamR1/Fittrackee/issues/17) - A user can delete his account
* [#15](https://github.com/SamR1/Fittrackee/issues/15) - Complete the administration
In this release 3 issues were closed.
## Version 0.2.5 - Fix and improvements (2020/01/31) ## Version 0.2.5 - Fix and improvements (2020/01/31)
### Misc ### Misc
@ -139,7 +157,7 @@ In this release 7 issues were closed.
- only activity owner can see his activity - only activity owner can see his activity
- no administration for now - no administration for now
➡️ more informations: see [wiki](https://github.com/SamR1/mpwo/wiki) and [current issues](https://github.com/SamR1/mpwo/issues) ➡️ more informations: see [documentation](https://samr1.github.io/FitTrackee/) and [current issues](https://github.com/SamR1/FitTrackee/issues)
### Issues Closed ### Issues Closed

View File

@ -4,10 +4,29 @@ Features
List List
~~~~ ~~~~
Users Account
^^^^^ ^^^^^^^
- Account creation (only standard user, not admin) - A user can create, update and deleted his account
- User registration can be disabled - Password reset is now available
Administration
^^^^^^^^^^^^^^
- Application
- active users limit (if 0, registration is enabled (no limit defined))
- maximum size of uploaded files
- maximum size of zip archive
- maximum number of files in the zip archive
- Users
- display users list and details
- edit a user to add/remove administration rights
- delete a user
- Sports
- enable or disable a sport (a sport can be disabled even if activity with this sport exists)
Activities/Workouts Activities/Workouts
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
@ -32,8 +51,7 @@ Activities/Workouts
**Notes:** **Notes:**
- only activity owner can see his activity - for now, only activity owner can see his activities
- **no administration for now**
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^
@ -63,3 +81,8 @@ Statistics
~~~~~~~~~~ ~~~~~~~~~~
.. figure:: _images/fittrackee_screenshot-04.png .. figure:: _images/fittrackee_screenshot-04.png
:alt: FitTrackee Statistics :alt: FitTrackee Statistics
Administration
~~~~~~~~~~~~~~
.. figure:: _images/fittrackee_screenshot-05.png
:alt: FitTrackee Administration

View File

@ -10,11 +10,11 @@ FitTrackee
| No mobile app is developed yet, but several existing mobile apps can | No mobile app is developed yet, but several existing mobile apps can
store workouts data locally and export them into a gpx file. store workouts data locally and export them into a gpx file.
| Examples (for Android): | Examples (for Android):
| \* `Runner Up <https://github.com/jonasoreland/runnerup>`__ (GPL v3) | \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3)
| \* `ForRunners <https://gitlab.com/brvier/ForRunners>`__ (GPL v3) | \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3)
| \* `AlpineQuest <https://www.alpinequest.net/>`__ (Proprietary, no | \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no
trackers according to `exodus privay trackers according to `exodus privay
report <https://reports.exodus-privacy.eu.org/reports/2975/>`__) report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_)
| Maps are displayed using `Open Street | Maps are displayed using `Open Street
Map <https://www.openstreetmap.org>`__. Map <https://www.openstreetmap.org>`__.

View File

@ -5,9 +5,10 @@ This application is written in Python (API) and Javascript (client):
- API: - API:
- Flask - Flask
- `gpxpy <https://github.com/tkrajina/gpxpy>`__ to parse gpx files - `gpxpy <https://github.com/tkrajina/gpxpy>`_ to parse gpx files
- `staticmap <https://github.com/komoot/staticmap>`__ to generate a static map image from gpx coordinates - `staticmap <https://github.com/komoot/staticmap>`_ to generate a static map image from gpx coordinates
- `python-forecast.io <https://github.com/ZeevG/python-forecast.io>`__ to fetch weather data from `Dark Sky <https://darksky.net>`__ (former forecast.io) - `python-forecast.io <https://github.com/ZeevG/python-forecast.io>`_ to fetch weather data from `Dark Sky <https://darksky.net>`__ (former forecast.io)
- `dramatiq <https://flask-dramatiq.readthedocs.io/en/latest/>`_ for task queue
- Client: - Client:
- React/Redux - React/Redux
- `Leaflet <https://leafletjs.com/>`__ to display map - `Leaflet <https://leafletjs.com/>`__ to display map
@ -19,12 +20,14 @@ Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
- PostgreSQL database (10+) - PostgreSQL database (10+)
- Redis for task queue
- Python 3.7+ - Python 3.7+
- `Poetry <https://poetry.eustace.io>`__ - `Poetry <https://poetry.eustace.io>`__
- `Yarn <https://yarnpkg.com>`__ and - `Yarn <https://yarnpkg.com>`__ and
`serve <https://github.com/zeit/serve>`__ `serve <https://github.com/zeit/serve>`__
- API key from `ThunderForest <http://thunderforest.com>`__ - API key from `ThunderForest <http://thunderforest.com>`__
- API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory] - API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory]
- SMTP provider
Installation Installation
@ -40,14 +43,14 @@ Installation
.. code-block:: bash .. code-block:: bash
$ yaourt poetry $ yay poetry
$ poetry --version $ poetry --version
Poetry 0.12.17 Poetry 1.0.5
# optional # optional
$ poetry config settings.virtualenvs.in-project true $ poetry config virtualenvs.in-project true
For other OS, see `Poetry Documentation <https://poetry.eustace.io/docs/#installation>`__ For other OS, see `Poetry Documentation <https://python-poetry.org/docs/#installation>`__
Dev environment Dev environment
@ -78,6 +81,12 @@ Dev environment
$ make serve $ make serve
- Run dramatiq workers:
.. code:: bash
$ make run-workers
Open http://localhost:3000 and login (the email is ``admin@example.com`` Open http://localhost:3000 and login (the email is ``admin@example.com``
and the password ``mpwoadmin``) or register and the password ``mpwoadmin``) or register
@ -87,13 +96,13 @@ Prod environment
.. warning:: .. warning::
Note that FitTrackee is not production-ready yet Note that FitTrackee is not production-ready yet
- Download the last release (for now, it is the beta release v0.2.5): - Download the last release (for now, it is the beta release v0.3.0):
.. code:: bash .. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.2.5-beta.tar.gz $ wget https://github.com/SamR1/FitTrackee/archive/v0.3.0-beta.tar.gz
$ tar -xzf v0.2.5-beta.tar.gz $ tar -xzf v0.3.0-beta.tar.gz
$ mv FitTrackee-0.2.3-beta FitTrackee $ mv FitTrackee-0.3.0-beta FitTrackee
$ cd FitTrackee $ cd FitTrackee
- Update **Makefile.config** file if needed and copy/paste the - Update **Makefile.config** file if needed and copy/paste the
@ -120,6 +129,12 @@ Prod environment
$ make run $ make run
- Run dramatiq workers:
.. code:: bash
$ make run-workers
Open http://localhost:3000, log in as admin (the email is Open http://localhost:3000, log in as admin (the email is
``admin@example.com`` and the password ``mpwoadmin``) and change the ``admin@example.com`` and the password ``mpwoadmin``) and change the
password password
@ -174,10 +189,28 @@ The following environment variables must be defined in **Makefile.custom.config*
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
variable description app default value variable description app default value
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 ``REACT_APP_API_URL`` Fittrackee API URL no default value, must be initialized
``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB ``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 (*deprecated in 0.3.0*)
``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB ``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB (*deprecated in 0.3.0*)
``REACT_APP_ALLOW_REGISTRATION`` allows users to register true ``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB (*deprecated in 0.3.0*)
``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key no defaut value, must be initialized ``REACT_APP_ALLOW_REGISTRATION`` allows users to register true (*deprecated in 0.3.0*)
``WEATHER_API`` DarkSky API key no defaut value, not mandatory ``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key no default value, must be initialized
``UI_URL`` application URL no default value, must be initialized
``EMAIL_URL`` email URL with credentials no default value, must be initialized (see below)
``SENDER_EMAIL`` application sender email address no default value, must be initialized
``REDIS_URL`` Redis instance used by Dramatiq local Redis instance
``WORKERS_PROCESSES`` number of process used by Dramatiq no default value, must be initialized
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
.. warning::
Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database.
Emails
^^^^^^
To send emails, a valid ``EMAIL_URL`` must be provided:
- with an unencrypted SMTP server: ``smtp://username:password@smtp.example.com:25``
- with SSL: ``smtp://username:password@smtp.example.com:465/?ssl=True``
- with STARTTLS: ``smtp://username:password@smtp.example.com:587/?tls=True``

View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.2.5-beta', VERSION: '0.3.0-beta',
LANGUAGE: 'None', LANGUAGE: 'None',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
BUILDER: 'html', BUILDER: 'html',

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Activities &#8212; FitTrackee 0.2.5-beta <title>Activities &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -1105,7 +1105,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Authentication &#8212; FitTrackee 0.2.5-beta <title>Authentication &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -615,7 +615,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Configuration &#8212; FitTrackee 0.2.5-beta <title>Configuration &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -266,7 +266,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API documentation &#8212; FitTrackee 0.2.5-beta <title>API documentation &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -152,7 +152,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Records &#8212; FitTrackee 0.2.5-beta <title>Records &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -249,7 +249,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sports &#8212; FitTrackee 0.2.5-beta <title>Sports &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -459,7 +459,7 @@ Authenticated user must be an admin</p>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Statistics &#8212; FitTrackee 0.2.5-beta <title>Statistics &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -397,7 +397,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Users &#8212; FitTrackee 0.2.5-beta <title>Users &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -489,7 +489,7 @@ one admin</p>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Change log &#8212; FitTrackee 0.2.5-beta <title>Change log &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -39,7 +39,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -76,60 +76,67 @@
role="menu" role="menu"
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Change log</a><ul> <li><a class="reference internal" href="#">Change log</a><ul>
<li><a class="reference internal" href="#version-0-3-0-administration-2020-07-xx">Version 0.3.0 - Administration (2020/07/xx)</a><ul>
<li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul>
<li><a class="reference internal" href="#new-features">New Features</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a><ul> <li><a class="reference internal" href="#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a><ul>
<li><a class="reference internal" href="#misc">Misc</a></li> <li><a class="reference internal" href="#misc">Misc</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a><ul> <li><a class="reference internal" href="#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a><ul>
<li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul> <li><a class="reference internal" href="#id1">Issues Closed</a><ul>
<li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li> <li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a><ul> <li><a class="reference internal" href="#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a><ul>
<li><a class="reference internal" href="#id1">Issues Closed</a><ul> <li><a class="reference internal" href="#id2">Issues Closed</a><ul>
<li><a class="reference internal" href="#new-features">New Features</a></li> <li><a class="reference internal" href="#id3">New Features</a></li>
<li><a class="reference internal" href="#id2">Bugs Fixed</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#version-0-2-2-statistics-fix-2019-09-23">Version 0.2.2 - Statistics fix (2019/09/23)</a><ul>
<li><a class="reference internal" href="#id3">Issues Closed</a><ul>
<li><a class="reference internal" href="#id4">Bugs Fixed</a></li> <li><a class="reference internal" href="#id4">Bugs Fixed</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-2-1-fix-and-improvements-2019-09-01">Version 0.2.1 - Fix and improvements (2019/09/01)</a><ul> <li><a class="reference internal" href="#version-0-2-2-statistics-fix-2019-09-23">Version 0.2.2 - Statistics fix (2019/09/23)</a><ul>
<li><a class="reference internal" href="#id5">Issues Closed</a><ul> <li><a class="reference internal" href="#id5">Issues Closed</a><ul>
<li><a class="reference internal" href="#id6">New Features</a></li> <li><a class="reference internal" href="#id6">Bugs Fixed</a></li>
<li><a class="reference internal" href="#id7">Bugs Fixed</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#id8">Misc</a></li> </ul>
</li>
<li><a class="reference internal" href="#version-0-2-1-fix-and-improvements-2019-09-01">Version 0.2.1 - Fix and improvements (2019/09/01)</a><ul>
<li><a class="reference internal" href="#id7">Issues Closed</a><ul>
<li><a class="reference internal" href="#id8">New Features</a></li>
<li><a class="reference internal" href="#id9">Bugs Fixed</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id10">Misc</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a><ul> <li><a class="reference internal" href="#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a><ul>
<li><a class="reference internal" href="#id9">Issues Closed</a><ul> <li><a class="reference internal" href="#id11">Issues Closed</a><ul>
<li><a class="reference internal" href="#id10">New Features</a></li> <li><a class="reference internal" href="#id12">New Features</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#id11">Misc</a></li> <li><a class="reference internal" href="#id13">Misc</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a><ul> <li><a class="reference internal" href="#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a><ul>
<li><a class="reference internal" href="#id12">Issues Closed</a><ul> <li><a class="reference internal" href="#id14">Issues Closed</a><ul>
<li><a class="reference internal" href="#id13">New Features</a></li> <li><a class="reference internal" href="#id15">New Features</a></li>
<li><a class="reference internal" href="#id14">Bugs Fixed</a></li> <li><a class="reference internal" href="#id16">Bugs Fixed</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-1-0-first-release-2018-07-04">Version 0.1.0 - First release 🎉 (2018-07-04)</a><ul> <li><a class="reference internal" href="#version-0-1-0-first-release-2018-07-04">Version 0.1.0 - First release 🎉 (2018-07-04)</a><ul>
<li><a class="reference internal" href="#id15">Issues Closed</a><ul> <li><a class="reference internal" href="#id17">Issues Closed</a><ul>
<li><a class="reference internal" href="#id16">New Features</a></li> <li><a class="reference internal" href="#id18">New Features</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -181,6 +188,26 @@
<div class="section" id="change-log"> <div class="section" id="change-log">
<h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1> <h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-3-0-administration-2020-07-xx">
<h2>Version 0.3.0 - Administration (2020/07/xx)<a class="headerlink" href="#version-0-3-0-administration-2020-07-xx" title="Permalink to this headline"></a></h2>
<p>This version introduces some major changes:</p>
<ul class="simple">
<li><p>FitTrackee administration is now available (see <a class="reference external" href="https://samr1.github.io/FitTrackee/features.html#administration">documentation</a>)<br />Note: some application parameters move from environment variables to database (see <a class="reference external" href="https://samr1.github.io/FitTrackee/installation.html#environment-variables">installation</a>).</p></li>
<li><p>in order to send emails, Redis is now a mandatory dependency</p></li>
</ul>
<div class="section" id="issues-closed">
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3>
<div class="section" id="new-features">
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/50">#50</a> - A user can reset his password</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/17">#17</a> - A user can delete his account</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/15">#15</a> - Complete the administration</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-2-5-fix-and-improvements-2020-01-31"> <div class="section" id="version-0-2-5-fix-and-improvements-2020-01-31">
<h2>Version 0.2.5 - Fix and improvements (2020/01/31)<a class="headerlink" href="#version-0-2-5-fix-and-improvements-2020-01-31" title="Permalink to this headline"></a></h2> <h2>Version 0.2.5 - Fix and improvements (2020/01/31)<a class="headerlink" href="#version-0-2-5-fix-and-improvements-2020-01-31" title="Permalink to this headline"></a></h2>
<div class="section" id="misc"> <div class="section" id="misc">
@ -197,8 +224,8 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-2-4-minor-fix-2020-01-30"> <div class="section" id="version-0-2-4-minor-fix-2020-01-30">
<h2>Version 0.2.4 - Minor fix (2020/01/30)<a class="headerlink" href="#version-0-2-4-minor-fix-2020-01-30" title="Permalink to this headline"></a></h2> <h2>Version 0.2.4 - Minor fix (2020/01/30)<a class="headerlink" href="#version-0-2-4-minor-fix-2020-01-30" title="Permalink to this headline"></a></h2>
<div class="section" id="issues-closed"> <div class="section" id="id1">
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="bugs-fixed"> <div class="section" id="bugs-fixed">
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
@ -211,17 +238,17 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-2-3-fittrackee-available-in-french-2019-12-29"> <div class="section" id="version-0-2-3-fittrackee-available-in-french-2019-12-29">
<h2>Version 0.2.3 - FitTrackee available in French (2019/12/29)<a class="headerlink" href="#version-0-2-3-fittrackee-available-in-french-2019-12-29" title="Permalink to this headline"></a></h2> <h2>Version 0.2.3 - FitTrackee available in French (2019/12/29)<a class="headerlink" href="#version-0-2-3-fittrackee-available-in-french-2019-12-29" title="Permalink to this headline"></a></h2>
<div class="section" id="id1"> <div class="section" id="id2">
<h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="new-features"> <div class="section" id="id3">
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/43">#43</a> - Display weekend days with a different background color on calendar</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/43">#43</a> - Display weekend days with a different background color on calendar</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/40">#40</a> - Localize FitTrackee (i18n)</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/40">#40</a> - Localize FitTrackee (i18n)</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id2"> <div class="section" id="id4">
<h4>Bugs Fixed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/44">#44</a> - Cannot edit an activity that does not have a gpx file</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/44">#44</a> - Cannot edit an activity that does not have a gpx file</p></li>
</ul> </ul>
@ -231,10 +258,10 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-2-2-statistics-fix-2019-09-23"> <div class="section" id="version-0-2-2-statistics-fix-2019-09-23">
<h2>Version 0.2.2 - Statistics fix (2019/09/23)<a class="headerlink" href="#version-0-2-2-statistics-fix-2019-09-23" title="Permalink to this headline"></a></h2> <h2>Version 0.2.2 - Statistics fix (2019/09/23)<a class="headerlink" href="#version-0-2-2-statistics-fix-2019-09-23" title="Permalink to this headline"></a></h2>
<div class="section" id="id3"> <div class="section" id="id5">
<h3>Issues Closed<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id4"> <div class="section" id="id6">
<h4>Bugs Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/41">#41</a> - User statistics are incorrect</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/41">#41</a> - User statistics are incorrect</p></li>
</ul> </ul>
@ -244,10 +271,10 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-2-1-fix-and-improvements-2019-09-01"> <div class="section" id="version-0-2-1-fix-and-improvements-2019-09-01">
<h2>Version 0.2.1 - Fix and improvements (2019/09/01)<a class="headerlink" href="#version-0-2-1-fix-and-improvements-2019-09-01" title="Permalink to this headline"></a></h2> <h2>Version 0.2.1 - Fix and improvements (2019/09/01)<a class="headerlink" href="#version-0-2-1-fix-and-improvements-2019-09-01" title="Permalink to this headline"></a></h2>
<div class="section" id="id5"> <div class="section" id="id7">
<h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id6"> <div class="section" id="id8">
<h4>New Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/4">#4</a> - Show points on the map when mouse over the chart</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/4">#4</a> - Show points on the map when mouse over the chart</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/14">#14</a> - Display segments informations</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/14">#14</a> - Display segments informations</p></li>
@ -258,15 +285,15 @@ add URL interceptors to simplify routes definition</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/37">#37</a> - Display map on activities list</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/37">#37</a> - Display map on activities list</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id7"> <div class="section" id="id9">
<h4>Bugs Fixed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/34">#34</a> - Weather is not displayed anymore</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/34">#34</a> - Weather is not displayed anymore</p></li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="section" id="id8"> <div class="section" id="id10">
<h3>Misc<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3> <h3>Misc<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><strong><a class="reference external" href="https://poetry.eustace.io/">Poetry</a></strong> replaces <strong><a class="reference external" href="https://docs.pipenv.org">pipenv</a></strong> for Python packages management</p></li> <li><p><strong><a class="reference external" href="https://poetry.eustace.io/">Poetry</a></strong> replaces <strong><a class="reference external" href="https://docs.pipenv.org">pipenv</a></strong> for Python packages management</p></li>
</ul> </ul>
@ -275,17 +302,17 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-2-0-statistics-2019-07-07"> <div class="section" id="version-0-2-0-statistics-2019-07-07">
<h2>Version 0.2.0 - Statistics (2019/07/07)<a class="headerlink" href="#version-0-2-0-statistics-2019-07-07" title="Permalink to this headline"></a></h2> <h2>Version 0.2.0 - Statistics (2019/07/07)<a class="headerlink" href="#version-0-2-0-statistics-2019-07-07" title="Permalink to this headline"></a></h2>
<div class="section" id="id9"> <div class="section" id="id11">
<h3>Issues Closed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<div class="section" id="id10"> <div class="section" id="id12">
<h4>New Features<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="section" id="id11"> <div class="section" id="id13">
<h3>Misc<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3> <h3>Misc<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Update dependencies</p></li> <li><p>Update dependencies</p></li>
</ul> </ul>
@ -294,17 +321,17 @@ add URL interceptors to simplify routes definition</p></li>
</div> </div>
<div class="section" id="version-0-1-1-fix-and-improvements-2019-02-07"> <div class="section" id="version-0-1-1-fix-and-improvements-2019-02-07">
<h2>Version 0.1.1 - Fix and improvements (2019/02/07)<a class="headerlink" href="#version-0-1-1-fix-and-improvements-2019-02-07" title="Permalink to this headline"></a></h2> <h2>Version 0.1.1 - Fix and improvements (2019/02/07)<a class="headerlink" href="#version-0-1-1-fix-and-improvements-2019-02-07" title="Permalink to this headline"></a></h2>
<div class="section" id="id12"> <div class="section" id="id14">
<h3>Issues Closed<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<div class="section" id="id13"> <div class="section" id="id15">
<h4>New Features<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/25">#25</a> - Display records on calendar</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/25">#25</a> - Display records on calendar</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/22">#22</a> - Add a total on current month statistics</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/22">#22</a> - Add a total on current month statistics</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id14"> <div class="section" id="id16">
<h4>Bugs Fixed<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/31">#31</a> - Use moving duration for stats</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/31">#31</a> - Use moving duration for stats</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/29">#29</a> - Pause duration calculation with segments</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/29">#29</a> - Pause duration calculation with segments</p></li>
@ -352,11 +379,11 @@ add URL interceptors to simplify routes definition</p></li>
<li><p>only activity owner can see his activity</p></li> <li><p>only activity owner can see his activity</p></li>
<li><p>no administration for now</p></li> <li><p>no administration for now</p></li>
</ul> </ul>
<p>➡️ more informations: see <a class="reference external" href="https://github.com/SamR1/mpwo/wiki">wiki</a> and <a class="reference external" href="https://github.com/SamR1/mpwo/issues">current issues</a></p> <p>➡️ more informations: see <a class="reference external" href="https://samr1.github.io/FitTrackee/">documentation</a> and <a class="reference external" href="https://github.com/SamR1/FitTrackee/issues">current issues</a></p>
<div class="section" id="id15"> <div class="section" id="id17">
<h3>Issues Closed<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<div class="section" id="id16"> <div class="section" id="id18">
<h4>New Features<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/11">#11</a> - Timezone support</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/11">#11</a> - Timezone support</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/10">#10</a> - Add a note to an activity</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/10">#10</a> - Add a note to an activity</p></li>
@ -383,7 +410,7 @@ add URL interceptors to simplify routes definition</p></li>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Features &#8212; FitTrackee 0.2.5-beta <title>Features &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -78,7 +78,8 @@
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Features</a><ul> <li><a class="reference internal" href="#">Features</a><ul>
<li><a class="reference internal" href="#list">List</a><ul> <li><a class="reference internal" href="#list">List</a><ul>
<li><a class="reference internal" href="#users">Users</a></li> <li><a class="reference internal" href="#account">Account</a></li>
<li><a class="reference internal" href="#administration">Administration</a></li>
<li><a class="reference internal" href="#activities-workouts">Activities/Workouts</a></li> <li><a class="reference internal" href="#activities-workouts">Activities/Workouts</a></li>
<li><a class="reference internal" href="#translations">Translations</a></li> <li><a class="reference internal" href="#translations">Translations</a></li>
</ul> </ul>
@ -87,6 +88,7 @@
<li><a class="reference internal" href="#activity-workout-detail">Activity/workout detail</a></li> <li><a class="reference internal" href="#activity-workout-detail">Activity/workout detail</a></li>
<li><a class="reference internal" href="#activities-workouts-list">Activities/workouts list</a></li> <li><a class="reference internal" href="#activities-workouts-list">Activities/workouts list</a></li>
<li><a class="reference internal" href="#statistics">Statistics</a></li> <li><a class="reference internal" href="#statistics">Statistics</a></li>
<li><a class="reference internal" href="#id1">Administration</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -140,11 +142,36 @@
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1> <h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<div class="section" id="list"> <div class="section" id="list">
<h2>List<a class="headerlink" href="#list" title="Permalink to this headline"></a></h2> <h2>List<a class="headerlink" href="#list" title="Permalink to this headline"></a></h2>
<div class="section" id="users"> <div class="section" id="account">
<h3>Users<a class="headerlink" href="#users" title="Permalink to this headline"></a></h3> <h3>Account<a class="headerlink" href="#account" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Account creation (only standard user, not admin)</p></li> <li><p>A user can create, update and deleted his account</p></li>
<li><p>User registration can be disabled</p></li> <li><p>Password reset is now available</p></li>
</ul>
</div>
<div class="section" id="administration">
<h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Application</p>
<ul>
<li><p>active users limit (if 0, registration is enabled (no limit defined))</p></li>
<li><p>maximum size of uploaded files</p></li>
<li><p>maximum size of zip archive</p></li>
<li><p>maximum number of files in the zip archive</p></li>
</ul>
</li>
<li><p>Users</p>
<ul>
<li><p>display users list and details</p></li>
<li><p>edit a user to add/remove administration rights</p></li>
<li><p>delete a user</p></li>
</ul>
</li>
<li><p>Sports</p>
<ul>
<li><p>enable or disable a sport (a sport can be disabled even if activity with this sport exists)</p></li>
</ul>
</li>
</ul> </ul>
</div> </div>
<div class="section" id="activities-workouts"> <div class="section" id="activities-workouts">
@ -181,8 +208,7 @@
</ul> </ul>
<p><strong>Notes:</strong></p> <p><strong>Notes:</strong></p>
<ul class="simple"> <ul class="simple">
<li><p>only activity owner can see his activity</p></li> <li><p>for now, only activity owner can see his activities</p></li>
<li><p><strong>no administration for now</strong></p></li>
</ul> </ul>
</div> </div>
<div class="section" id="translations"> <div class="section" id="translations">
@ -214,6 +240,12 @@
<img alt="FitTrackee Statistics" src="_images/fittrackee_screenshot-04.png" /> <img alt="FitTrackee Statistics" src="_images/fittrackee_screenshot-04.png" />
</div> </div>
</div> </div>
<div class="section" id="id1">
<h2>Administration<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<img alt="FitTrackee Administration" src="_images/fittrackee_screenshot-05.png" />
</div>
</div>
</div> </div>
@ -228,7 +260,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &#8212; FitTrackee 0.2.5-beta <title>Index &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -38,7 +38,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -126,7 +126,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>HTTP Routing Table &#8212; FitTrackee 0.2.5-beta <title>HTTP Routing Table &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -45,7 +45,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -314,7 +314,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>FitTrackee &#8212; FitTrackee 0.2.5-beta <title>FitTrackee &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -39,7 +39,7 @@
</button> </button>
<a class="navbar-brand" href="#"> <a class="navbar-brand" href="#">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -131,7 +131,7 @@ store workouts data locally and export them into a gpx file.</div>
<div class="line">* <a class="reference external" href="https://github.com/jonasoreland/runnerup">Runner Up</a> (GPL v3)</div> <div class="line">* <a class="reference external" href="https://github.com/jonasoreland/runnerup">Runner Up</a> (GPL v3)</div>
<div class="line">* <a class="reference external" href="https://gitlab.com/brvier/ForRunners">ForRunners</a> (GPL v3)</div> <div class="line">* <a class="reference external" href="https://gitlab.com/brvier/ForRunners">ForRunners</a> (GPL v3)</div>
<div class="line">* <a class="reference external" href="https://www.alpinequest.net/">AlpineQuest</a> (Proprietary, no <div class="line">* <a class="reference external" href="https://www.alpinequest.net/">AlpineQuest</a> (Proprietary, no
trackers according to <a class="reference external" href="https://reports.exodus-privacy.eu.org/reports/2975/">exodus privay trackers according to <a class="reference external" href="https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/">exodus privay
report</a>)</div> report</a>)</div>
</div> </div>
<div class="line-block"> <div class="line-block">
@ -164,6 +164,7 @@ Map</a>.</div>
<li class="toctree-l2"><a class="reference internal" href="features.html#activity-workout-detail">Activity/workout detail</a></li> <li class="toctree-l2"><a class="reference internal" href="features.html#activity-workout-detail">Activity/workout detail</a></li>
<li class="toctree-l2"><a class="reference internal" href="features.html#activities-workouts-list">Activities/workouts list</a></li> <li class="toctree-l2"><a class="reference internal" href="features.html#activities-workouts-list">Activities/workouts list</a></li>
<li class="toctree-l2"><a class="reference internal" href="features.html#statistics">Statistics</a></li> <li class="toctree-l2"><a class="reference internal" href="features.html#statistics">Statistics</a></li>
<li class="toctree-l2"><a class="reference internal" href="features.html#id1">Administration</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API documentation</a><ul> <li class="toctree-l1"><a class="reference internal" href="api/index.html">API documentation</a><ul>
@ -182,6 +183,7 @@ Map</a>.</div>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-3-0-administration-2020-07-xx">Version 0.3.0 - Administration (2020/07/xx)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a></li>
@ -208,7 +210,7 @@ Map</a>.</div>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation &#8212; FitTrackee 0.2.5-beta <title>Installation &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -88,7 +88,10 @@
<li><a class="reference internal" href="#id3">Prod environment</a></li> <li><a class="reference internal" href="#id3">Prod environment</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#environment-variables">Environment variables</a></li> <li><a class="reference internal" href="#environment-variables">Environment variables</a><ul>
<li><a class="reference internal" href="#emails">Emails</a></li>
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -148,6 +151,7 @@
<li><p><a class="reference external" href="https://github.com/tkrajina/gpxpy">gpxpy</a> to parse gpx files</p></li> <li><p><a class="reference external" href="https://github.com/tkrajina/gpxpy">gpxpy</a> to parse gpx files</p></li>
<li><p><a class="reference external" href="https://github.com/komoot/staticmap">staticmap</a> to generate a static map image from gpx coordinates</p></li> <li><p><a class="reference external" href="https://github.com/komoot/staticmap">staticmap</a> to generate a static map image from gpx coordinates</p></li>
<li><p><a class="reference external" href="https://github.com/ZeevG/python-forecast.io">python-forecast.io</a> to fetch weather data from <a class="reference external" href="https://darksky.net">Dark Sky</a> (former forecast.io)</p></li> <li><p><a class="reference external" href="https://github.com/ZeevG/python-forecast.io">python-forecast.io</a> to fetch weather data from <a class="reference external" href="https://darksky.net">Dark Sky</a> (former forecast.io)</p></li>
<li><p><a class="reference external" href="https://flask-dramatiq.readthedocs.io/en/latest/">dramatiq</a> for task queue</p></li>
</ul> </ul>
</dd> </dd>
</dl> </dl>
@ -167,12 +171,14 @@
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2> <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>PostgreSQL database (10+)</p></li> <li><p>PostgreSQL database (10+)</p></li>
<li><p>Redis for task queue</p></li>
<li><p>Python 3.7+</p></li> <li><p>Python 3.7+</p></li>
<li><p><a class="reference external" href="https://poetry.eustace.io">Poetry</a></p></li> <li><p><a class="reference external" href="https://poetry.eustace.io">Poetry</a></p></li>
<li><p><a class="reference external" href="https://yarnpkg.com">Yarn</a> and <li><p><a class="reference external" href="https://yarnpkg.com">Yarn</a> and
<a class="reference external" href="https://github.com/zeit/serve">serve</a></p></li> <a class="reference external" href="https://github.com/zeit/serve">serve</a></p></li>
<li><p>API key from <a class="reference external" href="http://thunderforest.com">ThunderForest</a></p></li> <li><p>API key from <a class="reference external" href="http://thunderforest.com">ThunderForest</a></p></li>
<li><p>API key from <a class="reference external" href="https://darksky.net/dev">Dark Sky</a> [not mandatory]</p></li> <li><p>API key from <a class="reference external" href="https://darksky.net/dev">Dark Sky</a> [not mandatory]</p></li>
<li><p>SMTP provider</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id1"> <div class="section" id="id1">
@ -186,15 +192,15 @@ necessary.</div>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>Since FitTrackee 0.2.1, Python packages installation needs Poetry. To install it on ArchLinux:</p> <p>Since FitTrackee 0.2.1, Python packages installation needs Poetry. To install it on ArchLinux:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ yaourt poetry <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ yay poetry
$ poetry --version $ poetry --version
Poetry <span class="m">0</span>.12.17 Poetry <span class="m">1</span>.0.5
<span class="c1"># optional</span> <span class="c1"># optional</span>
$ poetry config settings.virtualenvs.in-project <span class="nb">true</span> $ poetry config virtualenvs.in-project <span class="nb">true</span>
</pre></div> </pre></div>
</div> </div>
<p>For other OS, see <a class="reference external" href="https://poetry.eustace.io/docs/#installation">Poetry Documentation</a></p> <p>For other OS, see <a class="reference external" href="https://python-poetry.org/docs/#installation">Poetry Documentation</a></p>
</div> </div>
<div class="section" id="dev-environment"> <div class="section" id="dev-environment">
<h3>Dev environment<a class="headerlink" href="#dev-environment" title="Permalink to this headline"></a></h3> <h3>Dev environment<a class="headerlink" href="#dev-environment" title="Permalink to this headline"></a></h3>
@ -222,6 +228,12 @@ $ make install-db
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make serve <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make serve
</pre></div> </pre></div>
</div> </div>
<ul class="simple">
<li><p>Run dramatiq workers:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run-workers
</pre></div>
</div>
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and login (the email is <code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code> <p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and login (the email is <code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code>
and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) or register</p> and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) or register</p>
</div> </div>
@ -232,11 +244,11 @@ and the password <code class="docutils literal notranslate"><span class="pre">mp
<p>Note that FitTrackee is not production-ready yet</p> <p>Note that FitTrackee is not production-ready yet</p>
</div> </div>
<ul class="simple"> <ul class="simple">
<li><p>Download the last release (for now, it is the beta release v0.2.5):</p></li> <li><p>Download the last release (for now, it is the beta release v0.3.0):</p></li>
</ul> </ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ wget https://github.com/SamR1/FitTrackee/archive/v0.2.5-beta.tar.gz <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ wget https://github.com/SamR1/FitTrackee/archive/v0.3.0-beta.tar.gz
$ tar -xzf v0.2.5-beta.tar.gz $ tar -xzf v0.3.0-beta.tar.gz
$ mv FitTrackee-0.2.3-beta FitTrackee $ mv FitTrackee-0.3.0-beta FitTrackee
$ <span class="nb">cd</span> FitTrackee $ <span class="nb">cd</span> FitTrackee
</pre></div> </pre></div>
</div> </div>
@ -263,6 +275,12 @@ $ make install-db
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run
</pre></div> </pre></div>
</div> </div>
<ul class="simple">
<li><p>Run dramatiq workers:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run-workers
</pre></div>
</div>
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a>, log in as admin (the email is <p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a>, log in as admin (the email is
<code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code> and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) and change the <code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code> and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) and change the
password</p> password</p>
@ -311,9 +329,9 @@ $ make upgrade-db
<p>The following environment variables must be defined in <strong>Makefile.custom.config</strong>:</p> <p>The following environment variables must be defined in <strong>Makefile.custom.config</strong>:</p>
<table class="table-bordered table-striped docutils align-default"> <table class="table-bordered table-striped docutils align-default">
<colgroup> <colgroup>
<col style="width: 33%" /> <col style="width: 30%" />
<col style="width: 35%" /> <col style="width: 31%" />
<col style="width: 32%" /> <col style="width: 39%" />
</colgroup> </colgroup>
<thead> <thead>
<tr class="row-odd"><th class="head"><p>variable</p></th> <tr class="row-odd"><th class="head"><p>variable</p></th>
@ -322,32 +340,66 @@ $ make upgrade-db
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_GPX_LIMIT_IMPORT</span></code></p></td> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_API_URL</span></code></p></td>
<td><p>Fittrackee API URL</p></td>
<td><p>no default value, must be initialized</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_GPX_LIMIT_IMPORT</span></code></p></td>
<td><p>max. number of gpx file in zip archive</p></td> <td><p>max. number of gpx file in zip archive</p></td>
<td><p>10</p></td> <td><p>10 (<em>deprecated in 0.3.0</em>)</p></td>
</tr> </tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_MAX_SINGLE_FILE_SIZE</span></code></p></td> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_MAX_SINGLE_FILE_SIZE</span></code></p></td>
<td><p>max. size of a gpx or picture file</p></td> <td><p>max. size of a gpx or picture file</p></td>
<td><p>1MB</p></td> <td><p>1MB (<em>deprecated in 0.3.0</em>)</p></td>
</tr> </tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_MAX_ZIP_FILE_SIZE</span></code></p></td> <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_MAX_ZIP_FILE_SIZE</span></code></p></td>
<td><p>max. size of a zip archive</p></td> <td><p>max. size of a zip archive</p></td>
<td><p>10MB</p></td> <td><p>10MB (<em>deprecated in 0.3.0</em>)</p></td>
</tr> </tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_ALLOW_REGISTRATION</span></code></p></td> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_ALLOW_REGISTRATION</span></code></p></td>
<td><p>allows users to register</p></td> <td><p>allows users to register</p></td>
<td><p>true</p></td> <td><p>true (<em>deprecated in 0.3.0</em>)</p></td>
</tr> </tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_THUNDERFOREST_API_KEY</span></code></p></td> <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REACT_APP_THUNDERFOREST_API_KEY</span></code></p></td>
<td><p>ThunderForest API key</p></td> <td><p>ThunderForest API key</p></td>
<td><p>no defaut value, must be initialized</p></td> <td><p>no default value, must be initialized</p></td>
</tr> </tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">WEATHER_API</span></code></p></td> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">UI_URL</span></code></p></td>
<td><p>DarkSky API key</p></td> <td><p>application URL</p></td>
<td><p>no defaut value, not mandatory</p></td> <td><p>no default value, must be initialized</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">EMAIL_URL</span></code></p></td>
<td><p>email URL with credentials</p></td>
<td><p>no default value, must be initialized (see below)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">SENDER_EMAIL</span></code></p></td>
<td><p>application sender email address</p></td>
<td><p>no default value, must be initialized</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">REDIS_URL</span></code></p></td>
<td><p>Redis instance used by Dramatiq</p></td>
<td><p>local Redis instance</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">WORKERS_PROCESSES</span></code></p></td>
<td><p>number of process used by Dramatiq</p></td>
<td><p>no default value, must be initialized</p></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database.</p>
</div>
<div class="section" id="emails">
<h3>Emails<a class="headerlink" href="#emails" title="Permalink to this headline"></a></h3>
<p>To send emails, a valid <code class="docutils literal notranslate"><span class="pre">EMAIL_URL</span></code> must be provided:</p>
<ul class="simple">
<li><p>with an unencrypted SMTP server: <code class="docutils literal notranslate"><span class="pre">smtp://username:password&#64;smtp.example.com:25</span></code></p></li>
<li><p>with SSL: <code class="docutils literal notranslate"><span class="pre">smtp://username:password&#64;smtp.example.com:465/?ssl=True</span></code></p></li>
<li><p>with STARTTLS: <code class="docutils literal notranslate"><span class="pre">smtp://username:password&#64;smtp.example.com:587/?tls=True</span></code></p></li>
</ul>
</div>
</div> </div>
</div> </div>
@ -363,7 +415,7 @@ $ make upgrade-db
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

Binary file not shown.

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &#8212; FitTrackee 0.2.5-beta <title>Search &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -44,7 +44,7 @@
</button> </button>
<a class="navbar-brand" href="index.html"> <a class="navbar-brand" href="index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -147,7 +147,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

File diff suppressed because one or more lines are too long

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Administrator &#8212; FitTrackee 0.2.5-beta <title>Administrator &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -148,7 +148,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Troubleshooting &#8212; FitTrackee 0.2.5-beta <title>Troubleshooting &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -150,7 +150,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

View File

@ -4,7 +4,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User &#8212; FitTrackee 0.2.5-beta <title>User &#8212; FitTrackee 0.3.0-beta
documentation</title> documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -40,7 +40,7 @@
</button> </button>
<a class="navbar-brand" href="../index.html"> <a class="navbar-brand" href="../index.html">
FitTrackee</a> FitTrackee</a>
<span class="navbar-text navbar-version pull-left"><b>0.2.5</b></span> <span class="navbar-text navbar-version pull-left"><b>0.3.0</b></span>
</div> </div>
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
@ -141,7 +141,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2019, SamR1.<br/> &copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.<br/>
</p> </p>
</div> </div>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 599 KiB

After

Width:  |  Height:  |  Size: 598 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 539 KiB

After

Width:  |  Height:  |  Size: 541 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 205 KiB

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

View File

@ -26,7 +26,7 @@ def setup(app):
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'FitTrackee' project = 'FitTrackee'
copyright = '2018 - 2019, SamR1' copyright = '2018 - 2020, SamR1'
author = 'SamR1' author = 'SamR1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.

View File

@ -4,10 +4,29 @@ Features
List List
~~~~ ~~~~
Users Account
^^^^^ ^^^^^^^
- Account creation (only standard user, not admin) - A user can create, update and deleted his account
- User registration can be disabled - Password reset is now available
Administration
^^^^^^^^^^^^^^
- Application
- active users limit (if 0, registration is enabled (no limit defined))
- maximum size of uploaded files
- maximum size of zip archive
- maximum number of files in the zip archive
- Users
- display users list and details
- edit a user to add/remove administration rights
- delete a user
- Sports
- enable or disable a sport (a sport can be disabled even if activity with this sport exists)
Activities/Workouts Activities/Workouts
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
@ -32,8 +51,7 @@ Activities/Workouts
**Notes:** **Notes:**
- only activity owner can see his activity - for now, only activity owner can see his activities
- **no administration for now**
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^
@ -63,3 +81,8 @@ Statistics
~~~~~~~~~~ ~~~~~~~~~~
.. figure:: _images/fittrackee_screenshot-04.png .. figure:: _images/fittrackee_screenshot-04.png
:alt: FitTrackee Statistics :alt: FitTrackee Statistics
Administration
~~~~~~~~~~~~~~
.. figure:: _images/fittrackee_screenshot-05.png
:alt: FitTrackee Administration

View File

@ -10,11 +10,11 @@ FitTrackee
| No mobile app is developed yet, but several existing mobile apps can | No mobile app is developed yet, but several existing mobile apps can
store workouts data locally and export them into a gpx file. store workouts data locally and export them into a gpx file.
| Examples (for Android): | Examples (for Android):
| \* `Runner Up <https://github.com/jonasoreland/runnerup>`__ (GPL v3) | \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3)
| \* `ForRunners <https://gitlab.com/brvier/ForRunners>`__ (GPL v3) | \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3)
| \* `AlpineQuest <https://www.alpinequest.net/>`__ (Proprietary, no | \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no
trackers according to `exodus privay trackers according to `exodus privay
report <https://reports.exodus-privacy.eu.org/reports/2975/>`__) report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_)
| Maps are displayed using `Open Street | Maps are displayed using `Open Street
Map <https://www.openstreetmap.org>`__. Map <https://www.openstreetmap.org>`__.

View File

@ -5,9 +5,10 @@ This application is written in Python (API) and Javascript (client):
- API: - API:
- Flask - Flask
- `gpxpy <https://github.com/tkrajina/gpxpy>`__ to parse gpx files - `gpxpy <https://github.com/tkrajina/gpxpy>`_ to parse gpx files
- `staticmap <https://github.com/komoot/staticmap>`__ to generate a static map image from gpx coordinates - `staticmap <https://github.com/komoot/staticmap>`_ to generate a static map image from gpx coordinates
- `python-forecast.io <https://github.com/ZeevG/python-forecast.io>`__ to fetch weather data from `Dark Sky <https://darksky.net>`__ (former forecast.io) - `python-forecast.io <https://github.com/ZeevG/python-forecast.io>`_ to fetch weather data from `Dark Sky <https://darksky.net>`__ (former forecast.io)
- `dramatiq <https://flask-dramatiq.readthedocs.io/en/latest/>`_ for task queue
- Client: - Client:
- React/Redux - React/Redux
- `Leaflet <https://leafletjs.com/>`__ to display map - `Leaflet <https://leafletjs.com/>`__ to display map
@ -19,12 +20,14 @@ Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
- PostgreSQL database (10+) - PostgreSQL database (10+)
- Redis for task queue
- Python 3.7+ - Python 3.7+
- `Poetry <https://poetry.eustace.io>`__ - `Poetry <https://poetry.eustace.io>`__
- `Yarn <https://yarnpkg.com>`__ and - `Yarn <https://yarnpkg.com>`__ and
`serve <https://github.com/zeit/serve>`__ `serve <https://github.com/zeit/serve>`__
- API key from `ThunderForest <http://thunderforest.com>`__ - API key from `ThunderForest <http://thunderforest.com>`__
- API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory] - API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory]
- SMTP provider
Installation Installation
@ -40,14 +43,14 @@ Installation
.. code-block:: bash .. code-block:: bash
$ yaourt poetry $ yay poetry
$ poetry --version $ poetry --version
Poetry 0.12.17 Poetry 1.0.5
# optional # optional
$ poetry config settings.virtualenvs.in-project true $ poetry config virtualenvs.in-project true
For other OS, see `Poetry Documentation <https://poetry.eustace.io/docs/#installation>`__ For other OS, see `Poetry Documentation <https://python-poetry.org/docs/#installation>`__
Dev environment Dev environment
@ -78,6 +81,12 @@ Dev environment
$ make serve $ make serve
- Run dramatiq workers:
.. code:: bash
$ make run-workers
Open http://localhost:3000 and login (the email is ``admin@example.com`` Open http://localhost:3000 and login (the email is ``admin@example.com``
and the password ``mpwoadmin``) or register and the password ``mpwoadmin``) or register
@ -87,13 +96,13 @@ Prod environment
.. warning:: .. warning::
Note that FitTrackee is not production-ready yet Note that FitTrackee is not production-ready yet
- Download the last release (for now, it is the beta release v0.2.5): - Download the last release (for now, it is the beta release v0.3.0):
.. code:: bash .. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.2.5-beta.tar.gz $ wget https://github.com/SamR1/FitTrackee/archive/v0.3.0-beta.tar.gz
$ tar -xzf v0.2.5-beta.tar.gz $ tar -xzf v0.3.0-beta.tar.gz
$ mv FitTrackee-0.2.3-beta FitTrackee $ mv FitTrackee-0.3.0-beta FitTrackee
$ cd FitTrackee $ cd FitTrackee
- Update **Makefile.config** file if needed and copy/paste the - Update **Makefile.config** file if needed and copy/paste the
@ -120,6 +129,12 @@ Prod environment
$ make run $ make run
- Run dramatiq workers:
.. code:: bash
$ make run-workers
Open http://localhost:3000, log in as admin (the email is Open http://localhost:3000, log in as admin (the email is
``admin@example.com`` and the password ``mpwoadmin``) and change the ``admin@example.com`` and the password ``mpwoadmin``) and change the
password password
@ -174,10 +189,28 @@ The following environment variables must be defined in **Makefile.custom.config*
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
variable description app default value variable description app default value
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 ``REACT_APP_API_URL`` Fittrackee API URL no default value, must be initialized
``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB ``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 (*deprecated in 0.3.0*)
``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB ``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB (*deprecated in 0.3.0*)
``REACT_APP_ALLOW_REGISTRATION`` allows users to register true ``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB (*deprecated in 0.3.0*)
``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key no defaut value, must be initialized ``REACT_APP_ALLOW_REGISTRATION`` allows users to register true (*deprecated in 0.3.0*)
``WEATHER_API`` DarkSky API key no defaut value, not mandatory ``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key no default value, must be initialized
``UI_URL`` application URL no default value, must be initialized
``EMAIL_URL`` email URL with credentials no default value, must be initialized (see below)
``SENDER_EMAIL`` application sender email address no default value, must be initialized
``REDIS_URL`` Redis instance used by Dramatiq local Redis instance
``WORKERS_PROCESSES`` number of process used by Dramatiq no default value, must be initialized
===================================== ======================================= ==================================== ===================================== ======================================= ====================================
.. warning::
Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database.
Emails
^^^^^^
To send emails, a valid ``EMAIL_URL`` must be provided:
- with an unencrypted SMTP server: ``smtp://username:password@smtp.example.com:25``
- with SSL: ``smtp://username:password@smtp.example.com:465/?ssl=True``
- with STARTTLS: ``smtp://username:password@smtp.example.com:587/?tls=True``

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "fittrackee_api" name = "fittrackee_api"
version = "0.2.5-beta" version = "0.3.0-beta"
description = "" description = ""
authors = ["Your Name <you@example.com>"] authors = ["Your Name <you@example.com>"]
license = "GPL-3.0" license = "GPL-3.0"

View File

@ -17,7 +17,7 @@ export const getFileSizeInMB = fileSize => {
return (!fileSize && 0) || +value.toFixed(2) return (!fileSize && 0) || +value.toFixed(2)
} }
export const version = '0.2.5-beta' // version stored in 'utils' for now export const version = '0.3.0-beta' // version stored in 'utils' for now
export const apiUrl = `${process.env.REACT_APP_API_URL}/api/` export const apiUrl = `${process.env.REACT_APP_API_URL}/api/`
/* prettier-ignore */ /* prettier-ignore */
export const thunderforestApiKey = `${ export const thunderforestApiKey = `${

View File

@ -1,6 +1,6 @@
{ {
"name": "fittrackee_client", "name": "fittrackee_client",
"version": "0.1.0", "version": "0.3.0-beta",
"private": true, "private": true,
"dependencies": { "dependencies": {
"@mapbox/togeojson": "^0.16.0", "@mapbox/togeojson": "^0.16.0",