README.md

🏋️‍♀️GymQuest 📝

Table of Contents

1. What is GymQuest?
   • Technology stack
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

What is GymQuest?

GymQuest is the perfect tool for sports lovers who feel the need to track their progress in an intuitive and simple way! If you like our project feel free to contribute.

Key features

1.  Users

	-   Email
	    
	-   User
	    
	-   Password
	    
	-   Kg (optional)
	    
	-   Height
	    
	-   Weight
	    
	-   Kcal target
	    

2.  Exercises
	-   “How did I feel after this exercise”
	    
	-   Kg
	    
	-   Sets
	    
	-   Reps
	    
	-   Machine/tool used (Name)
    

3.  User statistics
	-   Weekly/monthly kcal loss
	    
	-   Weekly/monthly weight loss

4.  Machines/tools
	-   Name
	    
	-   Muscle/body area associated (Name)
   
5.  Muscles/body areas
	-   Name
	    
	-   Machine/tool associated (Name)
    
6.  Custom workout routines
	    
	-   Title

7.  Extra features:
    
	-   Consisting on a simple input from the user who will select machine/tools that they own and the app would suggest exercises suitable for them
	    
	-   A suggestion where the user specifies the body areas they want to reinforce so the app provides different options of tools/machines
   
	-   Share custom workouts with friends.

Technology stack

Code and Testing

• 
• 

Database

• 

UI/UX

• 
• 
• 

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To work with GymQuest project you will need to have and installed in your system.

Installation

At the moment there is no apk for GymQuest. Meanwhile, you can run the app using:

• Android Studio Emulator
• Your own Android device

Contributing

Firstly, we want to thank you for considering contributing to our project, since it's the people like you who make the app grow better!

We are open to any type of contribution such as:

• Proposing pull request to improve the code
• Submitting bug/issues reports
• Making suggestions
• Making questions in the issue section (search to see if someone else didn't ask the same question before!)
• Opening a discussion

Check the contributing guidelines for more details!

Quick contribution example:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. Check LICENSE.txt for more information.

Contact

This project was created by Álvaro Berjillos, Alejandro Luna and Igor Kuzx.

Project Link: https://github.com/alvarohghg/GymQuest