Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Sam 2019-08-31 19:11:46 +02:00
parent b7bc3a2107
commit 72cb1eb814
12 changed files with 219 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
CHANGELOG.md
View File

@ -1,6 +1,8 @@
# Change log
## Version 0.2.1 (2019/xx/xx)
## Version 0.2.1 - Fix and improvements (2019/xx/xx)
### Issues Closed
#### New Features
@ -15,6 +17,10 @@
* [#34](https://github.com/SamR1/Fittrackee/issues/34) - Weather is not displayed anymore
### Misc
* **[Poetry](https://poetry.eustace.io/)** replaces **[pipenv](https://docs.pipenv.org)** for Python packages management
In this release 7 issue were closed.
@ -26,7 +32,7 @@ In this release 7 issue were closed.
* [#13](https://github.com/SamR1/Fittrackee/issues/13) - Detailed statistics
#### Misc
### Misc
* Update dependencies
@ -53,7 +59,37 @@ In this release 1 issue was closed.
In this release 7 issues were closed.
## Version 0.1.0 - Minimal version (2018-07-04)
## Version 0.1.0 - First release 🎉 (2018-07-04)
**Features:**
- Account creation (only standard user, not admin)
- 6 sports supported:
- Cycling (Sport)
- Cycling (Transport)
- Hiking
- Montain Biking
- Running
- Walking
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- Activity edition and deletion
- An activity can be displayed with map (if with gpx), weather (if the DarkSky API key is provided) and charts (speed and elevation)
- A user can add a note
- Month calendar with activities
- Current month statistics
- Records by sports:
- average speed
- farest distance
- longest duration
- maximum speed
- Activities list and search
**Notes:**
- only activity owner can see his activity
- no administration for now
➡️ more informations: see [wiki](https://github.com/SamR1/mpwo/wiki) and [current issues](https://github.com/SamR1/mpwo/issues)
### Issues Closed

42
docs/_sources/changelog.md.txt
View File

@ -1,6 +1,8 @@
# Change log
## Version 0.2.1 (2019/xx/xx)
## Version 0.2.1 - Fix and improvements (2019/xx/xx)
### Issues Closed
#### New Features
@ -15,6 +17,10 @@
* [#34](https://github.com/SamR1/Fittrackee/issues/34) - Weather is not displayed anymore
### Misc
* **[Poetry](https://poetry.eustace.io/)** replaces **[pipenv](https://docs.pipenv.org)** for Python packages management
In this release 7 issue were closed.
@ -26,7 +32,7 @@ In this release 7 issue were closed.
* [#13](https://github.com/SamR1/Fittrackee/issues/13) - Detailed statistics
#### Misc
### Misc
* Update dependencies
@ -53,7 +59,37 @@ In this release 1 issue was closed.
In this release 7 issues were closed.
## Version 0.1.0 - Minimal version (2018-07-04)
## Version 0.1.0 - First release 🎉 (2018-07-04)
**Features:**
- Account creation (only standard user, not admin)
- 6 sports supported:
- Cycling (Sport)
- Cycling (Transport)
- Hiking
- Montain Biking
- Running
- Walking
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- Activity edition and deletion
- An activity can be displayed with map (if with gpx), weather (if the DarkSky API key is provided) and charts (speed and elevation)
- A user can add a note
- Month calendar with activities
- Current month statistics
- Records by sports:
- average speed
- farest distance
- longest duration
- maximum speed
- Activities list and search
**Notes:**
- only activity owner can see his activity
- no administration for now
➡️ more informations: see [wiki](https://github.com/SamR1/mpwo/wiki) and [current issues](https://github.com/SamR1/mpwo/issues)
### Issues Closed

21
docs/_sources/index.rst.txt
View File

@ -5,10 +5,6 @@
FitTrackee
==========
| |Python Version| |Flask Version| |React Version|
| |Codacy Badge| |Codacy Coverage Badge| [#f1]_ |Build Status|
| This web application allows you to track your outdoor activities from
gpx files and keep your data on your own server.
| No mobile app is developed yet, but several existing mobile apps can
@ -42,20 +38,3 @@ Table of contents
api/index
troubleshooting/index
changelog
.. |Python Version| image:: https://img.shields.io/badge/python-3.7-brightgreen.svg
:target: https://python.org
.. |Flask Version| image:: https://img.shields.io/badge/flask-1.1-brightgreen.svg
:target: http://flask.pocoo.org/
.. |React Version| image:: https://img.shields.io/badge/react-16.8-brightgreen.svg
:target: https://reactjs.org/
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d
:target: https://www.codacy.com/app/SamR1/FitTrackee
.. |Codacy Coverage Badge| image:: https://api.codacy.com/project/badge/Coverage/290a285f22e94132904dc13b4dd19d1d
:target: https://www.codacy.com/app/SamR1/FitTrackee
.. |Build Status| image:: https://travis-ci.org/SamR1/FitTrackee.svg?branch=master
:target: https://travis-ci.org/SamR1/FitTrackee
.. rubric:: Notes
.. [#f1] Test coverage: only for Python API

19
docs/_sources/installation.rst.txt
View File

@ -20,6 +20,7 @@ Prerequisites
- PostgreSQL database (10+)
- Python 3.7+
- `Poetry <https://poetry.eustace.io>`__
- `Yarn <https://yarnpkg.com>`__ and
`serve <https://github.com/zeit/serve>`__
- API key from `ThunderForest <http://thunderforest.com>`__
@ -34,6 +35,21 @@ Installation
| On other OS, some issues can be encountered and adaptations may be
necessary.
.. warning::
Since FitTrackee 0.2.1, Python packages installation needs Poetry. To install it on ArchLinux:
.. code-block:: bash
$ yaourt poetry
$ poetry --version
Poetry 0.12.17
# optional
$ poetry config settings.virtualenvs.in-project true
For other OS, see `Poetry Documentation <https://poetry.eustace.io/docs/#installation>`__
Dev environment
^^^^^^^^^^^^^^^
@ -128,11 +144,12 @@ Dev environment
- Update **Makefile.config** and **Makefile.custom.config** file if needed
- Reinstall packages if needed:
- Upgrade packages and database:
.. code:: bash
$ make install-dev
$ make upgrade-db
- Restart the server and the client:

6
docs/_static/custom.css vendored
View File

@ -46,16 +46,16 @@ html {
}
.alert-danger {
background-color: #d9534f;
background-color: #dc6460;
border-color: transparent;
}
.alert-info {
background-color: #29abe0;
background-color: #3eb3e3;
border-color: transparent;
}
.alert-warning {
background-color: #f47c3c;
background-color: #f5894f;
border-color: transparent;
}

112
docs/changelog.html
View File

@ -75,30 +75,34 @@
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Change log</a><ul>
<li><a class="reference internal" href="#version-0-2-1-2019-xx-xx">Version 0.2.1 (2019/xx/xx)</a><ul>
<li><a class="reference internal" href="#version-0-2-1-fix-and-improvements-2019-xx-xx">Version 0.2.1 - Fix and improvements (2019/xx/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>
<li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li>
</ul>
</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="#issues-closed">Issues Closed</a><ul>
<li><a class="reference internal" href="#id1">New Features</a></li>
<li><a class="reference internal" href="#misc">Misc</a></li>
</ul>
</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="#id1">Issues Closed</a><ul>
<li><a class="reference internal" href="#id2">New Features</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id3">Misc</a></li>
</ul>
</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="#id2">Issues Closed</a><ul>
<li><a class="reference internal" href="#id3">New Features</a></li>
<li><a class="reference internal" href="#id4">Bugs Fixed</a></li>
<li><a class="reference internal" href="#id4">Issues Closed</a><ul>
<li><a class="reference internal" href="#id5">New Features</a></li>
<li><a class="reference internal" href="#id6">Bugs Fixed</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#version-0-1-0-minimal-version-2018-07-04">Version 0.1.0 - Minimal version (2018-07-04)</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="#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="#id7">Issues Closed</a><ul>
<li><a class="reference internal" href="#id8">New Features</a></li>
</ul>
</li>
</ul>
@ -150,10 +154,12 @@
<div class="section" id="change-log">
<h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-2-1-2019-xx-xx">
<h2>Version 0.2.1 (2019/xx/xx)<a class="headerlink" href="#version-0-2-1-2019-xx-xx" title="Permalink to this headline"></a></h2>
<div class="section" id="version-0-2-1-fix-and-improvements-2019-xx-xx">
<h2>Version 0.2.1 - Fix and improvements (2019/xx/xx)<a class="headerlink" href="#version-0-2-1-fix-and-improvements-2019-xx-xx" title="Permalink to this headline"></a></h2>
<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">
<h3>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h3>
<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/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>
@ -164,45 +170,52 @@
</ul>
</div>
<div class="section" id="bugs-fixed">
<h3>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h3>
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4>
<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>
</ul>
</div>
</div>
<div class="section" id="misc">
<h3>Misc<a class="headerlink" href="#misc" title="Permalink to this headline"></a></h3>
<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>
</ul>
<p>In this release 7 issue were closed.</p>
</div>
</div>
<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>
<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="id1">
<h4>New Features<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h4>
<h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h4>New Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li>
</ul>
</div>
<div class="section" id="misc">
<h4>Misc<a class="headerlink" href="#misc" title="Permalink to this headline"></a></h4>
</div>
<div class="section" id="id3">
<h3>Misc<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Update dependencies</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
</div>
</div>
<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>
<div class="section" id="id2">
<h3>Issues Closed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h4>New Features<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h4>
<div class="section" id="id4">
<h3>Issues Closed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h4>New Features<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h4>
<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/22">#22</a> - Add a total on current month statistics</p></li>
</ul>
</div>
<div class="section" id="id4">
<h4>Bugs Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<div class="section" id="id6">
<h4>Bugs Fixed<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<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/29">#29</a> - Pause duration calculation with segments</p></li>
@ -214,12 +227,47 @@
</div>
</div>
</div>
<div class="section" id="version-0-1-0-minimal-version-2018-07-04">
<h2>Version 0.1.0 - Minimal version (2018-07-04)<a class="headerlink" href="#version-0-1-0-minimal-version-2018-07-04" title="Permalink to this headline"></a></h2>
<div class="section" id="id5">
<h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id6">
<h4>New Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<div class="section" id="version-0-1-0-first-release-2018-07-04">
<h2>Version 0.1.0 - First release 🎉 (2018-07-04)<a class="headerlink" href="#version-0-1-0-first-release-2018-07-04" title="Permalink to this headline"></a></h2>
<p><strong>Features:</strong></p>
<ul class="simple">
<li><p>Account creation (only standard user, not admin)</p></li>
<li><p>6 sports supported:</p>
<ul>
<li><p>Cycling (Sport)</p></li>
<li><p>Cycling (Transport)</p></li>
<li><p>Hiking</p></li>
<li><p>Montain Biking</p></li>
<li><p>Running</p></li>
<li><p>Walking</p></li>
</ul>
</li>
<li><p>Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
<li><p>Activity edition and deletion</p></li>
<li><p>An activity can be displayed with map (if with gpx), weather (if the DarkSky API key is provided) and charts (speed and elevation)</p></li>
<li><p>A user can add a note</p></li>
<li><p>Month calendar with activities</p></li>
<li><p>Current month statistics</p></li>
<li><p>Records by sports:</p>
<ul>
<li><p>average speed</p></li>
<li><p>farest distance</p></li>
<li><p>longest duration</p></li>
<li><p>maximum speed</p></li>
</ul>
</li>
<li><p>Activities list and search</p></li>
</ul>
<p><strong>Notes:</strong></p>
<ul class="simple">
<li><p>only activity owner can see his activity</p></li>
<li><p>no administration for now</p></li>
</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>
<div class="section" id="id7">
<h3>Issues Closed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id8">
<h4>New Features<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h4>
<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/10">#10</a> - Add a note to an activity</p></li>

14
docs/index.html
View File

@ -122,10 +122,6 @@
<div class="section" id="fittrackee">
<h1>FitTrackee<a class="headerlink" href="#fittrackee" title="Permalink to this headline"></a></h1>
<div class="line-block">
<div class="line"><a class="reference external" href="https://python.org"><img alt="Python Version" src="https://img.shields.io/badge/python-3.7-brightgreen.svg" /></a> <a class="reference external" href="http://flask.pocoo.org/"><img alt="Flask Version" src="https://img.shields.io/badge/flask-1.1-brightgreen.svg" /></a> <a class="reference external" href="https://reactjs.org/"><img alt="React Version" src="https://img.shields.io/badge/react-16.8-brightgreen.svg" /></a></div>
<div class="line"><a class="reference external" href="https://www.codacy.com/app/SamR1/FitTrackee"><img alt="Codacy Badge" src="https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d" /></a> <a class="reference external" href="https://www.codacy.com/app/SamR1/FitTrackee"><img alt="Codacy Coverage Badge" src="https://api.codacy.com/project/badge/Coverage/290a285f22e94132904dc13b4dd19d1d" /></a> <a class="footnote-reference brackets" href="#f1" id="id1">1</a> <a class="reference external" href="https://travis-ci.org/SamR1/FitTrackee"><img alt="Build Status" src="https://travis-ci.org/SamR1/FitTrackee.svg?branch=master" /></a></div>
</div>
<div class="line-block">
<div class="line">This web application allows you to track your outdoor activities from
gpx files and keep your data on your own server.</div>
<div class="line">No mobile app is developed yet, but several existing mobile apps can
@ -184,20 +180,14 @@ Map</a>.</div>
</ul>
</li>
<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-2-1-2019-xx-xx">Version 0.2.1 (2019/xx/xx)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-1-fix-and-improvements-2019-xx-xx">Version 0.2.1 - Fix and improvements (2019/xx/xx)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-0-minimal-version-2018-07-04">Version 0.1.0 - Minimal version (2018-07-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-0-first-release-2018-07-04">Version 0.1.0 - First release 🎉 (2018-07-04)</a></li>
</ul>
</li>
</ul>
</div>
<p class="rubric">Notes</p>
<dl class="footnote brackets">
<dt class="label" id="f1"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>Test coverage: only for Python API</p>
</dd>
</dl>
</div>

17
docs/installation.html
View File

@ -167,6 +167,7 @@
<ul class="simple">
<li><p>PostgreSQL database (10+)</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://yarnpkg.com">Yarn</a> and
<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>
@ -181,6 +182,19 @@ on Debian and Arch).</div>
<div class="line">On other OS, some issues can be encountered and adaptations may be
necessary.</div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</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
$ poetry --version
Poetry <span class="m">0</span>.12.17
<span class="c1"># optional</span>
$ poetry config settings.virtualenvs.in-project <span class="nb">true</span>
</pre></div>
</div>
<p>For other OS, see <a class="reference external" href="https://poetry.eustace.io/docs/#installation">Poetry Documentation</a></p>
</div>
<div class="section" id="dev-environment">
<h3>Dev environment<a class="headerlink" href="#dev-environment" title="Permalink to this headline"></a></h3>
<ul class="simple">
@ -273,9 +287,10 @@ password</p>
</div>
<ul class="simple">
<li><p>Update <strong>Makefile.config</strong> and <strong>Makefile.custom.config</strong> file if needed</p></li>
<li><p>Reinstall packages if needed:</p></li>
<li><p>Upgrade packages and database:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make install-dev
$ make upgrade-db
</pre></div>
</div>
<ul class="simple">

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

6
docsrc/source/_static/custom.css
View File

@ -46,16 +46,16 @@ html {
}
.alert-danger {
background-color: #d9534f;
background-color: #dc6460;
border-color: transparent;
}
.alert-info {
background-color: #29abe0;
background-color: #3eb3e3;
border-color: transparent;
}
.alert-warning {
background-color: #f47c3c;
background-color: #f5894f;
border-color: transparent;
}

21
docsrc/source/index.rst
View File

@ -5,10 +5,6 @@
FitTrackee
==========
| |Python Version| |Flask Version| |React Version|
| |Codacy Badge| |Codacy Coverage Badge| [#f1]_ |Build Status|
| This web application allows you to track your outdoor activities from
gpx files and keep your data on your own server.
| No mobile app is developed yet, but several existing mobile apps can
@ -42,20 +38,3 @@ Table of contents
api/index
troubleshooting/index
changelog
.. |Python Version| image:: https://img.shields.io/badge/python-3.7-brightgreen.svg
:target: https://python.org
.. |Flask Version| image:: https://img.shields.io/badge/flask-1.1-brightgreen.svg
:target: http://flask.pocoo.org/
.. |React Version| image:: https://img.shields.io/badge/react-16.8-brightgreen.svg
:target: https://reactjs.org/
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d
:target: https://www.codacy.com/app/SamR1/FitTrackee
.. |Codacy Coverage Badge| image:: https://api.codacy.com/project/badge/Coverage/290a285f22e94132904dc13b4dd19d1d
:target: https://www.codacy.com/app/SamR1/FitTrackee
.. |Build Status| image:: https://travis-ci.org/SamR1/FitTrackee.svg?branch=master
:target: https://travis-ci.org/SamR1/FitTrackee
.. rubric:: Notes
.. [#f1] Test coverage: only for Python API

19
docsrc/source/installation.rst
View File

@ -20,6 +20,7 @@ Prerequisites
- PostgreSQL database (10+)
- Python 3.7+
- `Poetry <https://poetry.eustace.io>`__
- `Yarn <https://yarnpkg.com>`__ and
`serve <https://github.com/zeit/serve>`__
- API key from `ThunderForest <http://thunderforest.com>`__
@ -34,6 +35,21 @@ Installation
| On other OS, some issues can be encountered and adaptations may be
necessary.
.. warning::
Since FitTrackee 0.2.1, Python packages installation needs Poetry. To install it on ArchLinux:
.. code-block:: bash
$ yaourt poetry
$ poetry --version
Poetry 0.12.17
# optional
$ poetry config settings.virtualenvs.in-project true
For other OS, see `Poetry Documentation <https://poetry.eustace.io/docs/#installation>`__
Dev environment
^^^^^^^^^^^^^^^
@ -128,11 +144,12 @@ Dev environment
- Update **Makefile.config** and **Makefile.custom.config** file if needed
- Reinstall packages if needed:
- Upgrade packages and database:
.. code:: bash
$ make install-dev
$ make upgrade-db
- Restart the server and the client: