search

Software-Engineering-2024-Group / BurnoutExtreme

MIT License
0 stars 0 forks source link

readme


Logo

BurnoutExtreme

Your ultimate health and wellness companion 🏃‍♀️💪
A holistic platform to help you manage fitness, diet, and health goals, built on the success of the original Burnout project.
Explore the API docs »

View Demo · Request Feature
View Video · Scores · Developer Documentation


GitHub license DOI made-with-python Build Status Frontend Test Status Unit Test Status Coverage Status AutoPep8 PEP8 Flake8 Status Repository size Open Issues Closed Issues Closed Pull Requests Python Style Checker Contributors Forks Stars Join the Discord Server

BurnoutExtreme

Table of Contents

🔥 BurnoutExtreme: More Power, More Progress, More You! 🔥

Are you determined to achieve your dream physique? Desiring to take charge of your health? Looking for a platform that offers everything from calorie counting to enrolling in exciting fitness events? Welcome to BurnoutExtreme – the only health and fitness companion you'll ever need.

🚀What's New?

New and Improved Features!

💡 Why Choose BurnoutExtreme?

In today's fast-paced world, maintaining health is a challenge. But with the right tools and community, this challenge becomes an enjoyable journey. And BurnoutExtreme is here to make sure of that.

🌟 Key Features

So, are you ready to take the leap towards a healthier, happier you? Dive into BurnoutExtreme now and elevate your fitness game!

🔥 Because it's not just about burning calories; it's about burning doubts, burning procrastination, and lighting up confidence! 🔥

Walkthrough

TODO: Change vedio link

Link to the implementation video of the BurnoutExtreme application: Video

📸Application Screenshots

🔐Sign-In

image

🏠Homepage

image

🎨Personalised Themes

image

👤Profile

image

Events

image

My Meals

image

My Workouts

image

❓FAQs

image

📞Contact Us

image

TODO: replaced with updated Tutorials.md

:memo: Note: Additional screenshots and a mini tutorials can be found here:Tutorials.md

Project TechStack

html React
mongo MongoDB
python Python

Getting started

Follow these steps to set up and run the application on your local machine.

Prerequisites

Before you begin, make sure you have the following installed:

Step 1: Git Clone the Repository

git clone https://github.com/aditikilledar/burnout-proj3

Step 2: Ensure mongodb is running and execute the below to populate the tables: Navigate to the backend folder.

cd backend

Once in the backend, run:

python insert_event_data.py
python insert_food_data.py

Step 3: Remain in the backend folder and run the following command to start the server:

pip install -r requirements.txt
flask run

Step 4: Navigate to the frontend folder and run the below to start the React app:

cd frontend
npm install
npm start

Step 5: Open the URL in your browser:
http://127.0.0.1:3000

Bug Fixes

We fixed many bugs, more details in our Issues view...

🚀Future Enhancements

The BurnoutExtreme application can be extended with the following features:

  1. 🍽️ Categorize Meals
    Automatically categorize meals into breakfast, lunch, dinner, or snacks, making meal tracking faster and more intuitive.

  2. 📱 Mobile Support
    Fully optimized interface for seamless use across all devices, ensuring users can access their fitness journey anywhere.

  3. 📅 Weekly Tracking
    Track weight weekly and compare actual progress with target goals, helping users stay accountable and motivated.

  4. 🔍 Sorting & Filtering Capabilities
    Implement sorting and filtering options to help users easily navigate their meals and workouts.

  5. 🍏 Personalized Suggestions
    Receive personalized meal and workout suggestions tailored to individual health goals, promoting a balanced and effective approach to wellness.

📊 Score Card

Total Grade: 151

Factor Score Notes
Video 3 https://youtu.be/xQB6AbBLLWU?si=4RX05gmUf6D-M-7v
Workload 3 Distributed
Number of commits 3 50+
Number of commits: by different people 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/graphs/contributors
Issues report: There are many 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/pulse
Issues are being closed 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/pulse
DOI badge 3
Docs: format 3
Docs: description 3
Docs: short animated video 3
Docs: strong punchlines 3
Docs: mini tutorials 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/blob/master/Tutorials.md#signup-and-sign-in
Use of version control tools 3
Use of style checkers 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/blob/master/.github/workflows/autopep8.yml
Use of code formatters. 3
Use of syntax checkers. 3
Use of code coverage 3
Other automated analysis tools 2
Test cases exist 3
Test cases are routinely executed 2
The files http://contributing.md/ lists coding standards and lots of tips 3
Issues are discussed before they are closed 3
Chat channel: exists 3 whatsapp, discord
Test cases: a large proportion of the issues related to handling failing cases. 3
Evidence that the whole team is using the same tools 3
Evidence that the members of the team are working across multiple places in the code base 3
Short release cycles 3
Does your website and documentation provide a clear, high-level overview of your software? 3
Does your website and documentation clearly describe the type of user who should use your software? 3
Do you publish case studies to show how your software has been used by yourself and others? 3
Is the name of your project/software unique? 3
Is your project/software name free from trademark violations? 3
Is your software available as a package that can be deployed without building it? 3
Is your software available for free? 3
Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository? 3
Is your software hosted in an established, third-party repository like GitHub? 3
Is your documentation clearly available on your website or within your software? 3
Does your documentation include a "quick start" guide, that provides a short overview of how to use your software with some basic examples of use? 2
If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software? 3
Do you provide a comprehensive guide to all your software’s commands, functions and options? 3
Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages? 3
If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation? 3 https://github.com/Software-Engineering-2024-Group/BurnoutExtreme/blob/master/backend/html/backend/index.html
Do you store your documentation under revision control with your source code? 2
Do you publish your release history e.g. release data, version numbers, key features of each release etc. on your web site or in your documentation? 3
Does your software describe how a user can get help with using your software? 3
Does your website and documentation describe what support, if any, you provide to users and developers? 3
Does your project have an e-mail address or forum that is solely for supporting users? 3
Are e-mails to your support e-mail address received by more than one person? 3
Does your project have a ticketing system to manage bug reports and feature requests? 2
Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests? 3

🙌Contributors

Soundarya Khanapur
Soundarya Khanapur
Mugdha Joshi
Mugdha Joshi
Jing Huang
Jing Huang

🌟 Previous Team Contributors

Aditya Iyer
Aditya Iyer
Aditi Killedar
Aditi Killedar 		Shashank Madan
Shashank Madan
Srinath Srinivasan
Srinath Srinivasan

🤝Contribution

Please refer to the CONTRIBUTING.md file for instructions on how to contribute to our repository.

📜License

This project is licensed under the MIT License. Please refer to the LICENSE for more details.