Merge pull request #4 from joaovitoriasilva/Backend-optimization-v0.1.2

Backend optimization v0.1.2

.gitignore

@@ -4,5 +4,8 @@ backend/*/__pycache__/
 backend/*.pyc
 
 # Logs
-backend/logs/
-backend/*.log
+backend/logs/*.log
+backend/*.log
+
+# Frontend
+frontend/img/users_img/*.*

README.md

@@ -1,3 +1,16 @@
+<div align="center">
+  <img src="frontend/img/logo/logo.png" width="128" height="128">
+
+  # Endurain
+
+  A self-hosted fitness tracking service
+
+  <img src="screenshot_01.png">
+</div>
+
+> [!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 a combination of PHP, HTML, basic JavaScript, and Bootstrap CSS. On the backend, it leverages Python FastAPI and stravalib for seamless integration with Strava. 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 readily 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.
@@ -35,6 +48,8 @@ To do features (not by order):
  - 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.
@@ -76,6 +91,9 @@ JAEGER_PROTOCOL | http | Yes
 JAEGER_HOST | jaeger | Yes
 JAGGER_PORT | 4317 | Yes
 STRAVA_DAYS_ACTIVITIES_ONLINK | 30 | Yes
+API_ENDPOINT* | changeme | Yes
+
+*API_ENDPOINT needs to be set if you want to enable Strava integration
 
 Table bellow shows the obligatory environemnt variables for mariadb container. You should set them based on what was also set for backend container.
 

backend/.env

@@ -14,4 +14,5 @@ JAEGER_ENABLED=true
 JAEGER_PROTOCOL=http
 JAEGER_HOST=jaeger
 JAGGER_PORT=4317
-STRAVA_DAYS_ACTIVITIES_ONLINK=30
+STRAVA_DAYS_ACTIVITIES_ONLINK=30
+API_ENDPOINT=changeme

backend/constants.py

@@ -0,0 +1,6 @@
+# Constant related to version
+API_VERSION="v0.1.2"
+
+# Constants related to user access types
+ADMIN_ACCESS = 2
+REGULAR_ACCESS = 1