update documentation

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

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;
}

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

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: