github/endurain
1
1
Fork 0
mirror of https://github.com/joaovitoriasilva/endurain.git synced 2026-01-08 23:38:01 -05:00
Code Issues 45 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
João Vitória Silva
2024-09-06 23:54:39 +01:00
parent 8c82b27580
commit ceafdf75ea
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -29,8 +29,7 @@ Currently the service supports:
- Multi-user
- Create/edit/delete users
- Basic admin and regular user profiles that adapt the interface
- Import activities using .gpx files
- Bulk import for activity files
- Import activities manually or using bulk import (.gpx and .fit files supported)
- 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
@@ -47,7 +46,6 @@ Currently the service supports:
- 3rd party apps
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
@@ -63,7 +61,7 @@ To support this in your implementation you will need to:
# Frontend
Table bellow shows supported environment variables. Variables marked with optional "No" should be set to avoid errors.
Environemnt variable | Default value | Optional | Notes
Environment variable | Default value | Optional | Notes
--- | --- | --- | ---
MY_APP_BACKEND_PROTOCOL | http | Yes | Needs to be https 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 (api host or local ip (example: http://192.168.1.10:98))
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 (api host or local ip (example: http://192.168.1.10:98))
@@ -77,7 +75,7 @@ Frontend dependencies:
# Backend
Table bellow shows supported environment variables. Variables marked with optional "No" should be set to avoid errors.
Environemnt variable | Default value | Optional | Notes
Environment variable | Default value | Optional | Notes
--- | --- | --- | ---
DB_HOST | mariadb | Yes | N/A
DB_PORT | 3306 | Yes | N/A
@@ -100,9 +98,9 @@ FRONTEND_PROTOCOL | http | Yes | Needs to be set if you want to enable Strava in
FRONTEND_HOST | frontend:8080 | 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 or local ip (example: http://192.168.1.10:8080))
GEOCODES_MAPS_API | changeme | `No` | <a href="https://geocode.maps.co/">Geocode maps</a> 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.
Table bellow shows the obligatory environment variables for mariadb container. You should set them based on what was also set for backend container.
Environemnt variable | Default value | Optional | Notes
Environment variable | Default value | Optional | Notes
--- | --- | --- | ---
MYSQL_ROOT_PASSWORD | changeme | `No` | N/A
MYSQL_DATABASE | endurain | `No` | N/A