Dylan- Project Portfolio Page

Overview

Our AY22/23 Sem 2 CS2113 (Software Engineering) Team Project A CLI based fitness tracker intended to give users a way to manage and learn new workouts. We hope to be able to encourage individuals who are interested in keeping fit so that they can live a healthy lifestyle.

Summary of Contributions

Below lists the contributions that I have provided to FitnessDuke. Here is the contributed done by me: Reposense Link to my code

Features Implemented

Feature: easy, medium, hard filters

• What it does: Implemented the parameters/filters used when generating a list of exercises of a specific difficulty level and the corresponding error checks.
  
• Justification: The JSON file used the words Beginner, Intermediate, Expert for their .getLevel() function, which I believed was not user-friendly enough from the user’s perspective as we do not want the user to guess whether they are a beginner or an expert. Rather we wanted to give the user the perspective of whether they want an easy workout or a hard one, which is a reflection of the exercise, not the user.
• Highlights: The feature parses the easy, medium, hard inputs and returns a Beginner, Intermediate or Expert output that is given to the GenerateExercise class for filtering. The “easy”, “medium” and “hard” strings are then returned as output when printing.

Feature: start current

• What it does: Starts a workout session, logging the last generated exercise session using the GenerateExercise class.
• Justification: This is one of the core features of Fitness Duke. Since motivating a user to exercise is the main reason why we are developing FitnessDuke, creating a feature that provides an indication to the user that he or she can start exercising is essential to FitnessDuke.
• Highlights: Switches the command handler to a different state, where the focus is on completing one’s workout. Commands after using the start command are limited to a few commands. This is meant to emphasize the importance of completing one’s workout. More details of this can be seen below.
• Able to print all current workouts in a sessions as well

Feature: finish cancel

• What it does: Finishes or cancels the current workout session. If using the finish command, it will save the exercise session as a completed exercise session.
• Justification: A user may finish, or decide to give up on a workout session. If they finish a session, they
• Highlights: Using the finish command will save the current workout session into a json file. Finishing exercises also add current exercise counts to the achievements list. If an achievement is completed at this stage, a congratulations message will pop up and a list of all completed achievements will appear.

Feature: achievements clear_achievements

• What it does: A list of achievements that can be achieved by finishing workout sessions. Calling the achievements command will list all the available achievements and their details (i.e. name, requirements, difficulty level, current count), and whether they have been achieved or not.
• Justification: Continuously motivating the user is essential to keeping them healthy in the long run. Creating achievements to give them arbitrary goals is a way to give users an extrinsic source of motivation to continue using FitnessDuke to exercise.
• Highlights: Different achievements have different difficulties, with an increasing number of exercises required. Higher difficulties have a higher number of “stars” (i.e. asterisks *) attached to them, hopefully enticing users to want to achieve them.

Enhancements to existing features

• Wrote JUnit tests for our Storage.java API UserDataStorageTest.java(excluding achievements) Tests the saving and reading of data to and from the local hard disk and checks the handling of missing files.
• Wrote JUnit tests for generating hybrid exercises from resources file GenerateMixtureExerciseTest.java.
• Wrote JUnit tests for the achievements use cases in the resources folder test/java/seedu.duke/achievemets.
• Help source and organise commands across the entire program by implementing the CommandList. This was due to the many command handlers that we had, I was able to streamline common commands this way.
• Helped implement the ErrorMessages enumeration, allowing easy access to error messages. This allows for the same error message to be accessed and displayed easily for similar errors.

Contributions to the DG

• Wrote how the AchievementListHandler.java API in the DG alongside how it is stored and used. This includes the UML diagrams used as well.
• Added test cases for achievement related areas.
• Added user stories.

Contributions to the UG

• Added HTML and CSS styling to ensure that the users were more aware of very specific interactions with our system and how specific interactions with certain files might cause unwanted consequences. This allows for better user readability in terms of recognizing Tips and Caution related messaged.
• Added achievements and clear_achievements commands and use cases.
• Added example inputs and outputs for most of the commands.
• Contributed to the explanations of the usage of certain commands (i.e. achievements).

Contributions to team tasks

• Release management
• • Made the Finish Group Deliverables milestone for FitnessDuke, ensuring that everyone has submitted and completed what they wanted to contribute for the tema tasks.
• Helped maintain the issue tracker in the projects folder
• • Tagged and assigned certain issues to different people
• • Tagged issues with their respective tags (i.e. severity, type)

Review/mentoring contributions

• Helped review PRs and made comments to them throughout the project
• Reviewed multiple PRs and made comments to all of them throughout the project.
• Helped debug code and guided team members on how to fix them.
• Taught people how to use git for those that were less experienced in it.