ATRA (Another Tool for Running/Route Analysis) is an online tool that helps users analyze the data from their running activities so that they can get insights from their data. It will also have a social aspect, allowing users to create groups called Murals. In these groups, users could compare their times to friend's times, set group goals, or compare routes.
This project is my (Ángel Marqués) TFG. As such, it is guided by a professor from King Juan Carlos University, and follows a specific format. This format is divided into 5 phases, and as such, so will this readme file.
This is the planning phase. It records information about the project, like its entities and functionalities.
App Name: ATRA (Another Tool for Running/Route Analysis) Student: Ángel Marqués García Tutor: Micael Gallego Carrillo Cotutor: Rubén Morante González
Blog: GitHub Project: https://github.com/orgs/codeurjc-students/projects/14
Actions preceded by (~) are optional/potential. They are actions that COULD be implemented, however, they might not be neccessary or helpful. As such, they are recorded, so that they are considered, but if they are not implemented, they will be deleted from this table.
| Entity | Description | Created when | Deleted when | Actions | Related to |
|---|---|---|---|---|---|
| User | Holds all the information about a specific user | An anonymous user signs up | A user deletes their account | - delete user -edit profile |
-Mural -Activity -(optional) Route |
| Activity | Holds information about a given activity. The gpx holding its data, as well as metrics derived from that for quicker access. | A user uploads a GPX or a new Activity is detected in Strava | The user it belongs to chooses to do so | -Delete -Visualize data -Analyze data -Add to Route -Change visibility -(advanced) Compare data |
-(optional) Route: the route it takes place in - (optional) User: the user who owns it |
| Route | Holds information about a route. | A user chooses to do so, taking an activity as a base (advanced) When the algorithm recognizes a new route When importing data from Strava |
It no longer has any activities A user (its creator) chooses to do so (unsure that this is a good idea) |
-View activities -(~) Add activity (from a list of activities with no route. I would rather giving a route an activity be handled from the activity's side) -(~) Remove activity (same as before) |
-Activity: list of the activities on this route -(optional) User: list of users with at least one activity on this route |
| Mural | Holds a list of users, and is used to show the data from all of them. Users can join with its id, and they can decide what activities they want a Mural to access. | A user chooses to do so | Its owner chooses to do so | -Join -Leave -(advanced) Kick user -View data (activities and analysis) |
-User: list of Users that are part of the Mural -(optional) Activity: list of visible activities (to make access quicker) -(optional) Route: list of Routes such that at least one of the activities owned happens on that route |
Functionalities will be divided into two groups: Basic and Advanced. Basic functionalities form part of the MVP, and will be implemented in Phase 1. Advanced functionalities are improvements or additional tools. They are not strictly neccessary for the core of the app, but are still good to have. They are further divided into "Must have" and "Optional" functionalities. "Must have" functionalities are considered essential for the app to have. They add important functionalities that the app should have before release. "Optional" functionalities add additional functionalities or quality of life improvements, however those functionalities and improvements are not as essential for the app. As such, some might not be implemented by the time this project is completed.
| Entity | Functionality |
|---|---|
| User | -Login -Logout -Delete account -Edit account -Set Profile Picture -Sign up |
| Mural | -Create Mural -Delete Mural -Join Mural -See Mural page |
| Activity | -Upload Activity (GPX) -Sync with Strava -View Activity data -Analyze Activity data -Change activity visibility |
| Route | -Create Route -Assign Route to Activity -Link image to Route -Visualize and Analyze cumulative data |
| Entity | Must have | Optional |
|---|---|---|
| User | -Access full functionality as anonymous -Download session -Customize home page/dashboard -Download infographic |
|
| Mural | - Invite user to Mural - Own Mural - Kick user from owned Mural - Compare activities in Mural - Only Owner can delete Mural |
- Highlight when users reach a goal/break a record - Endorse other's activities (give medals or similar) |
| Activity | - Compare 2 activities in the same route - Compare an activity with its route avg |
- Automatically assign Route - Compare two activities on different Routes - Upload activity (TCX) |
| Route | - Automatically create Route from Activities - Automatically identify Segments - Show a 3D map - Add an autorunner (strava's is super cool) |
The following table lists user permissions as they should be in the completed app. However, since accessing full functionality as an anonymous user is considered an advanced functionality, it might not be implemented, and anonymous users would only be able to log in.
| Action | Anonymous | Registered | Admin |
|---|---|---|---|
| Analyze Activities | yes | yes | yes |
| Compare Activities | yes | yes | yes |
| Create Route | yes | yes | yes |
| Join Mural | no | yes | yes |
| Create Mural | no | yes | yes |
| Activities are saved in database | no | yes | yes |
The app will be able to handle images uploaded by users, and potentially also generate images for users to download.
- Users can upload a profile picture
- Routes can have an image linked
- (advanced) Users can download an infographic summarizing their training and achievements
Graphs are essential to the app. After all, it is a tool to help users analyze and visualize the data from their running activities, and graphs are a great tool for that. The app will use many different types of graphs. Some examples are below:
- Line graphs (pace/time)
- Bar graphs (avg pace/week)
- Histograms (% of time in each heartrate zone)
- Scatter plots (distribution of pace readings)
- Pie charts (% of total distance contributed by each member in a Mural)
- Rainfall diagrams and similar (pace distribution/activity)
- And potentially others
The format of the TFG requires the use of some type of complimentary technology, like accessing an API or similar. This will be achieved through the following:
- A mapping API will be used to show the route taken
- The app will connect to the Strava API to request a user's activities
- (Optional) The app could send emails to users when reaching specific goals
The format of the TFG requires the use of some advanced algorithm or query. Given the nature of the project, it is not hard to implement some type of algorithm. For example:
- Some metrics could be obtained by applying specific algorithms (GAP)
- Analyzing activities will make use of various algorithms
- Comparing activities will make use of various algorithms
- Algorithms could be used to automatically identify and assign Routes to Activities
- Algorithms could be used to automatically detect and create segments within a Route/Activity
- A recommendation algorithm could be implemented to suggest similar routes to ones you've participated in.
Lastly, what follows is a sketch showing the design of the main windows the users will navigate, as well as indications on how to traverse through them, and some notes indicating how the app is expected to behave.
This phase covers the implementation of the webpage with, at minimum, all functionalities listed as "basic" in phase 0. It should have:
- backend with an API REST
- frontend with SPA technology
- Automatic testing
- Packaging using Docker and Docker Compose
Phase 2 is centered around integration and continuous delivery. It will be implemented through GitHub Actions. When this phase is over, testing and packaging should happen automatically.
In this phase the final version will be developed. A subset of the "advanced" functionalities will be implemented, and testing will be increased subsequently.
In this phase no new progress will be made on the app itself; it should already be completed. Instead, it is dedicated to writing the report.
Phase 5 consists of presenting the project before a tribunal and conducting its defense.