Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (40 loc) · 1.74 KB

swim-data-analyser

The swim-data-analyser is a tool to manipulate and analyze swim workouts from FIT files as provided by Garmin devices. It is heavily inspired by Swimming Watch Tools.

The goal is to provide full client-side parsing and handling of the data, ensuring that no data is transmitted to the server. In the future, long term analysis of workouts is planned. For this use case, an appropriate backend with user handling will be developed. While a database is necessary for this purpose, basic parsing and analysis of single workouts will remain client-side for casual website users.

developement

The project uses Nix flakes to manage developement dependencies. You can follow the setup instructions provided in the section 'Setup' of this tutorial.

dev environment:

nix develop

getting started:

npm install

spin up dev server:

npx webpack --watch
python manage.py runserver

deployment

  1. Clone the repository:
git clone https://github.com/PeterK-end/swim-data-analyser
  • adjust swim_data_analyser/settings.py
    • change SECRET_KEY and ALLOWED_HOSTS
  1. Build the Docker Image
docker build -t swim-data-analyser:latest .
  1. Serve static content and Docker
docker run -p 8000:8000 -v /srv/swim-data-analyser:/app/static swim-data-analyser:latest
  • make sure to serve static content /srv/swim-data-analyser via your webserver and proxy requests to 8000

Used libraries

The project depends on some core libraries listed below: