Skip to content

My DIY fitness tracker journey. Frontend is built using Vue.js and Bootstrap CSS; Python FastAPI, Alembic, SQLAlchemy, stravalib, gpxpy, MariaDB behind the scenes. Suggestions welcome!

License

Notifications You must be signed in to change notification settings

schwier-xyz/endurain

 
 

Repository files navigation

Endurain

A self-hosted fitness tracking service • Endurain Mastodon profile

Warning

This project is currently in Alpha state. You can try it out at your own risk, but be aware that things might break and DATA LOSS may occur.

Endurain is a self-hosted fitness tracking service that operates much like Strava but allows users to have complete control over their data and the hosting environment. The application's frontend is built using Vue.js and Bootstrap CSS. On the backend, it leverages Python FastAPI, Alembic, SQLAlchemy, stravalib and gpxpy for seamless integration with Strava and .gpx file import. The MariaDB database engine is employed to efficiently store and manage user data, while Jaeger is used for basic observability.

To deploy Endurain, Docker images are available, and a comprehensive example can be found in the "docker-compose.yml" file provided. Configuration is facilitated through environment variables, ensuring flexibility and ease of customization.

As a non-professional developer, my journey with Endurain involved learning and implementing new technologies and concepts, with invaluable assistance from ChatGPT. The primary motivation behind this project was to gain hands-on experience and expand my understanding of modern development practices. Second motivation is that I'm an amateur triathlete and I want to keep track of my gear and gear components usage.

If you have any recommendations or insights on improving any aspect of Endurain, whether related to technology choices, user experience, or any other relevant area, I would greatly appreciate your input. The goal is to create a reliable and user-friendly fitness tracking solution that caters to the needs of individuals who prefer self-hosted applications. Your constructive feedback will undoubtedly contribute to the refinement of Endurain.

Default credentials are:

  • User: admin
  • Password: admin

Currently the service supports:

  • Multi-user
  • Create/edit/delete users
  • Basic admin and regular users profiles that adapt the interface
  • Import activities using .gpx files
  • Connect with Strava and retrieve activities and gear from Strava
  • Feed with user activities, current user week stats and month stats
  • Feed with followers activities
  • Basic activity privacy
  • Activity page with more in depth info of the activity
  • Delete activities
  • Create/edit/delete gear (wetsuit, bycicle and running shoes)
  • Add/edit/delete activity gear
  • User page with user stats and user activities per week
  • Follow user basic implementation
  • Multi-language support, but currently only English is available
  • Basic gear tracking usage

To do features (not by order):

  • Support import of .fit files
  • Default gear for activity type
  • Gear components logic for component usage tracking
  • Comments and likes logic for activities
  • Notifications logic
  • Activity Pub integration?

More screenshots: https://imgur.com/a/lDR0sBf


Frontend

Table bellow shows supported environemnt variables. Variables marked with optional "No" should be set to avoid errors.

Environemnt variable Default value Optional Notes
MY_APP_BACKEND_PROTOCOL http Yes Needs to be https if you want to enable Strava integration. You may need to update this variable based on docker image spin up
MY_APP_BACKEND_HOST localhost:98 Yes Needs to be set and be Internet faced/resolved if you want to enable Strava integration. Strava callback relies on this. You may need to update this variable based on docker image spin up

Frontend dependencies:

  • vue@3.4.24
  • vue-router@4.3.2
  • vue-i18n@9.13.1
  • vite@5.2.10
  • pinia@2.1.7
  • crypto-js@4.2.0
  • chart.js@4.4.2
  • User avatars create using DiceBear (https://www.dicebear.com) avataaars style.
  • Bootstrap CSS v5.3.3
  • leaflet v1.9.4
  • fontawesome icons free version@6.5.2 and vue-fontawesome@3.0.6
  • Logo created using Canvas

Backend

Table bellow shows supported environemnt variables. Variables marked with optional "No" should be set to avoid errors.

Environemnt variable Default value Optional Notes
DB_HOST mariadb Yes N/A
DB_PORT 3306 Yes N/A
DB_USER gearguardian Yes N/A
DB_PASSWORD changeme No N/A
DB_DATABASE gearguardian Yes N/A
SECRET_KEY changeme No N/A
ALGORITHM HS256 Yes N/A
ACCESS_TOKEN_EXPIRE_MINUTES 30 Yes N/A
STRAVA_CLIENT_ID changeme No N/A
STRAVA_CLIENT_SECRET changeme No N/A
STRAVA_AUTH_CODE changeme No N/A
JAEGER_ENABLED true Yes N/A
JAEGER_PROTOCOL http Yes N/A
JAEGER_HOST jaeger Yes N/A
JAGGER_PORT 4317 Yes N/A
STRAVA_DAYS_ACTIVITIES_ONLINK 30 Yes N/A
FRONTEND_PROTOCOL http Yes Needs to be set if you want to enable Strava integration. You may need to update this variable based on docker image spin up
FRONTEND_HOST frontend Yes Needs to be set if you want to enable Strava integration. You may need to update this variable based on docker image spin up
FRONTEND_PORT frontend Yes Needs to be set if you want to enable Strava integration. You may need to update this variable based on docker image spin up
GEOCODES_MAPS_API changeme No Geocode maps offers a free plan consisting of 1 Request/Second. Registration necessary.

Table bellow shows the obligatory environemnt variables for mariadb container. You should set them based on what was also set for backend container.

Environemnt variable Default value Optional Notes
MYSQL_ROOT_PASSWORD changeme No N/A
MYSQL_DATABASE gearguardian No N/A
MYSQL_USER gearguardian No N/A
MYSQL_PASSWORD changeme No N/A

Python backend dependencies used:

  • fastapi==0.111.0
  • pydantic==1.10.15
  • uvicorn==0.29.0
  • python-dotenv==1.0.1
  • sqlalchemy==2.0.30
  • mysqlclient==2.2.4
  • python-jose[cryptography]==3.3.0
  • passlib[bcrypt]==1.7.4
  • apscheduler==3.10.4
  • requests==2.32.2
  • stravalib==1.7
  • opentelemetry-sdk==1.22.0
  • opentelemetry-instrumentation-fastapi==0.43b0
  • opentelemetry.exporter.otlp==1.22.0
  • python-multipart==0.0.9
  • gpxpy==1.6.2
  • alembic==1.13.1

Strava integration

For Strava integration API endpoint must be available to the Internet. You will also need to create a API Application using a Strava account -> more info here https://developers.strava.com/docs/getting-started/

About

My DIY fitness tracker journey. Frontend is built using Vue.js and Bootstrap CSS; Python FastAPI, Alembic, SQLAlchemy, stravalib, gpxpy, MariaDB behind the scenes. Suggestions welcome!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 47.7%
  • Python 43.7%
  • JavaScript 8.1%
  • Other 0.5%