zain-iqbal-3000/lean-mass

LeanMass Fitness App

Overview Welcome to the LeanMass Fitness App repository! LeanMass is a web application designed to assist individuals in achieving their fitness goals by providing personalized BMI calculations, diet recommendations, and exercise guidance. This README will guide you through the setup, features, and contributions to the project.

Table of Contents

1. Installation
2. Features
3. Usage
4. Contributing
5. License

Installation

To get started with LeanMass, follow these steps:

Clone the Repository:

bash Copy code git clone https://github.com/your-username/LeanMass.git cd LeanMass Install Dependencies:

npm install -g create-vite npm install npm install react-router-dom npm install @react-oauth/google npm install --save @fortawesome/fontawesome-free npm install --save bootstrap npm install --save tailwindcss

Access the App: Open the terminal in your code editor and run npm run dev ctrl+click on the link i.e. http://localhost:3000 to use LeanMass.

Features

1. BMI Calculation Users can input their weight, height, and age to calculate their Body Mass Index (BMI). Receive instant feedback on BMI status and recommended ranges.
2. Personalized Guidance Based on BMI, users will receive personalized diet and exercise recommendations. Tailored suggestions for a healthier lifestyle.
3. Interactive 3D Models Engage users with interactive 3D models demonstrating various exercises. Highlight vulnerable points during exercises for safer workouts.
4. Text-to-Speech Functionality Enhance user experience with text-to-speech features. Provide audible guidance for exercises or other relevant information. Usage

User Registration:

Users can create accounts to save their progress and preferences.

1. BMI Calculation: Input weight, height, and age to calculate BMI. View BMI status and recommended ranges.
2. Personalized Guidance:Receive personalized diet and exercise recommendations.
3. Interactive Videos: Explore interactive videos for exercise demonstrations.
4. Text-to-Speech:Enable text-to-speech for audible guidance.

Contributing

We welcome contributions to make LeanMass better. To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature/fix: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m 'Add feature'.
4. Push to the branch: git push origin feature-name.
5. Submit a pull request.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for your own purposes.

Thank you for choosing LeanMass! We hope this app contributes to a healthier and happier lifestyle. If you have any questions or feedback, feel free to contact us.