update documentation
This commit is contained in:
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
@ -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:
|
||||
|
||||
|
Reference in New Issue
Block a user