Installation

This application is written in Python (API) and Javascript (client):

• API:

  • Flask

  • gpxpy to parse gpx files

  • staticmap to generate a static map image from gpx coordinates

  • python-forecast.io to fetch weather data from Dark Sky (former forecast.io)

• Client:

  • React/Redux

  • Leaflet to display map

  • Recharts to display charts with elevation and speed

Sports and weather icons are made by Freepik from www.flaticon.com.

Prerequisites

• PostgreSQL database (10+)

• Python 3.7+

• Yarn and serve

• API key from ThunderForest

• API key from Dark Sky [not mandatory]

Installation

The following steps describe an installation on Linux systems (tested on Debian and Arch).

On other OS, some issues can be encountered and adaptations may be necessary.

Dev environment

• Clone this repo:

$ git clone https://github.com/SamR1/FitTrackee.git
$ cd FitTrackee

• Update Makefile.config file if needed and copy/paste the ThunderForest and Dark Sky API keys value in Makefile.custom.config file (see example). User registration can also be disabled in Makefile.custom.config.

• Install Python virtualenv, React and all related packages and initialize the database:

$ make install-dev
$ make install-db

• Start the server and the client:

$ make serve

Open http://localhost:3000 and login (the email is admin@example.com and the password mpwoadmin) or register

Prod environment

Warning

Note that FitTrackee is not production-ready yet

• Download the last release (for now it is the beta release v0.2.0):

$ wget https://github.com/SamR1/FitTrackee/archive/v0.2.0-beta.tar.gz
$ tar -xzf v0.2.0-beta.tar.gz
$ mv FitTrackee-0.2.0-beta FitTrackee
$ cd FitTrackee

• Update Makefile.config file if needed and copy/paste the ThunderForest and Dark Sky API keys value in Makefile.custom.config file (see example). User registration can also be disabled in Makefile.custom.config.

• Install Python virtualenv, React and all related packages and initialize the database:

$ make install
$ make install-db

• Build the client:

$ make build-client

• Start the server and the client:

$ make run

Open http://localhost:3000, log in as admin (the email is admin@example.com and the password mpwoadmin) and change the password

Upgrade

Warning

Before upgrading, make a backup of all data:

- database (with pg_dump for instance)

- upload directory: FitTrackee/fittrackee_api/fittrackee_api/uploads/

Dev environment

• Stop the application and pull the repository:

$ git pull

• Update Makefile.config and Makefile.custom.config file if needed

• Reinstall packages if needed:

$ make install-dev

• Restart the server and the client:

$ make serve

Prod environment

TODO