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

Docker - update fittrackee-client

Browse Source
This commit is contained in:
Sam
2021-11-06 22:18:38 +01:00
parent c7024e6692
commit 1013b5cdca
11 changed files with 100 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
docsrc/source/installation.rst
View File

@ -191,62 +191,12 @@ deployment method.
**Dark Sky** API key for weather data (not mandatory).
.. envvar:: REACT_APP_API_URL
.. envvar:: VUE_APP_API_URL
**FitTrackee** API URL, only needed in dev environment.
Deprecated variables
^^^^^^^^^^^^^^^^^^^^
.. envvar:: REACT_APP_GPX_LIMIT_IMPORT
.. deprecated:: 0.3.0 now stored in database
Maximum number of gpx file in zip archive.
:default: 10
.. envvar:: REACT_APP_MAX_SINGLE_FILE_SIZE
.. deprecated:: 0.3.0 now stored in database
Maximum size of a gpx or picture file.
:default: 1MB
.. envvar:: REACT_APP_MAX_ZIP_FILE_SIZE
.. deprecated:: 0.3.0 now stored in database
Maximum size of a zip archive.
:default: 10MB
.. envvar:: REACT_APP_ALLOW_REGISTRATION
.. deprecated:: 0.3.0 now stored in database
Allows users to register.
:default: true
.. envvar:: REACT_APP_THUNDERFOREST_API_KEY
.. deprecated:: 0.4.0 see `TILE_SERVER_URL <installation.html#envvar-TILE_SERVER_URL>`__
ThunderForest API key.
.. warning::
| Since FitTrackee 0.3.0, some applications parameters are now stored in database.
| Related environment variables are needed to initialize database when upgrading from version prior 0.3.0.
Emails
^^^^^^
.. versionadded:: 0.3.0
@ -409,7 +359,7 @@ Dev environment
- Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv, React and all related packages and
- Install Python virtualenv, Vue and all related packages and
initialize the database:
.. code:: bash
@ -439,13 +389,13 @@ 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.9):
- Download the last release (for now, it is the release v0.5.0):
.. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.9.tar.gz
$ tar -xzf v0.4.9.tar.gz
$ mv FitTrackee-0.4.9 FitTrackee
$ wget https://github.com/SamR1/FitTrackee/archive/v0.5.0.tar.gz
$ tar -xzf v0.5.0.tar.gz
$ mv FitTrackee-0.5.0 FitTrackee
$ cd FitTrackee
- Create **.env** from example and update it
@ -520,13 +470,13 @@ Prod environment
- Change to the directory where FitTrackee directory is located
- Download the last release (for now, it is the release v0.4.9) and overwrite existing files:
- Download the last release (for now, it is the release v0.5.0) and overwrite existing files:
.. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.9.tar.gz
$ tar -xzf v0.4.9.tar.gz
$ cp -R FitTrackee-0.4.9/* FitTrackee/
$ wget https://github.com/SamR1/FitTrackee/archive/v0.5.0.tar.gz
$ tar -xzf v0.5.0.tar.gz
$ cp -R FitTrackee-0.5.0/* FitTrackee/
$ cd FitTrackee
- Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).
@ -704,19 +654,25 @@ Open http://localhost:8025 to access `MailHog interface <https://github.com/mail
$ make docker-shell
Client Development
^^^^^^^^^^^^^^^^^^
Development
^^^^^^^^^^^
.. versionadded:: 0.4.10
.. versionadded:: 0.5.0
- in order to start client with React dev tools, install `fittrackee_client`
- an additional step is to install `fittrackee_client`
.. code-block:: bash
$ make docker-build-client
- start React app
- to start **FitTrackee** with client dev tools:
.. code-block:: bash
$ make docker-serve-client
$ make docker-serve-client
Open http://localhost:3000 and log in (the email is ``admin@example.com``
and the password ``mpwoadmin``) or register
.. note::
Some environment variables need to be updated like `UI_URL`