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
2021-07-10 10:46:44 +02:00
parent 90765d733b
commit fc86ddbbed
8 changed files with 52 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docsrc/source/installation.rst
View File

@ -26,7 +26,7 @@ Prerequisites
- API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory]
- SMTP provider
- `Yarn <https://yarnpkg.com>`__ (for development only)
- Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or evaluation purposes)
- Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or for evaluation purposes)
.. note::
| The following steps describe an installation on Linux systems (tested
@ -396,7 +396,7 @@ Dev environment
$ git clone https://github.com/SamR1/FitTrackee.git
$ cd FitTrackee
- Create **Makefile.custom.config** from example and update it
- Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv, React and all related packages and
@ -429,16 +429,16 @@ Production environment
.. warning::
| Note that FitTrackee is under heavy development, some features may be unstable.
- Download the last release (for now, it is the release v0.4.0):
- Download the last release (for now, it is the release v0.4.8):
.. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.0.tar.gz
$ tar -xzf v0.4.0.tar.gz
$ mv FitTrackee-0.4.0 FitTrackee
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.8.tar.gz
$ tar -xzf v0.4.8.tar.gz
$ mv FitTrackee-0.4.8 FitTrackee
$ cd FitTrackee
- Create **Makefile.custom.config** from example and update it
- Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv and all related packages:
@ -512,7 +512,7 @@ Prod environment
$ git pull
- Update **Makefile.custom.config** if needed
- Update **.env** if needed
- Upgrade packages and database:

12
docsrc/source/troubleshooting/administrator.rst
View File

@ -2,9 +2,13 @@ Administrator
#############
`JSON.parse: unexpected character at line 1 column 1 of the JSON data`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
`FitTrackee fails to start`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the **Network Tab**, if the requests are made to `http://localhost:3000/undefined/api`, that means the environnement variable **REACT_APP_API_URL** is not initialized.
- Check the database URL in `Environment variables <../installation.html#envvar-DATABASE_URL>`__ if the following error is displayed in **gunicorn** logs:
Check if **Makefile.custom.config** file exists and **REACT_APP_API_URL** is correctly initialized (see `example <https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example>`__), and rebuild the client.
.. code::
sqlalchemy.exc.NoSuchModuleError: Can't load plugin: sqlalchemy.dialects:postgres
It must start with `postgresql://` (engine URLs starting with `postgres://` are no longer supported).