BURNOUT

Your daily health companion 🏃‍♀️
Explore the API docs »

View Demo · Report Bug · Request Feature

🔥 Burnout: Elevate Your Health & Fitness Game! 🔥

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 Burnout – the only health and fitness companion you'll ever need.

• 🍎 Nutrition Made Simple: Navigating the complex world of nutrition can be daunting. With Burnout, you can effortlessly track what you eat and gain insights into your calorie consumption. Whether you're having a quick salad or indulging in a cheat meal, every bite counts. And we're here to count it for you!

• 🔥 Ignite Your Calorie Burn: Exercise isn't just about looking good; it's about feeling good too. Track every step taken, every calorie burned, and every drop of sweat shed. Watch yourself progress as Burnout pushes you to achieve your health goals.

• 🏊 Dive into Exciting Fitness Events: Bored of your routine workout? Dive into an array of fitness events – from calming yoga sessions to adrenaline-pumping gym workouts. Whether you're into swimming, walking, or exploring new activities, there's something for everyone. Get social, challenge yourself, and discover activities you love.

• 📊 Tailored To You: Everyone's health journey is unique. Input your age, current weight, height, target weight, and goals, and let Burnout craft a personalized plan for you. Watch in real-time as you inch closer to your goals and celebrate each milestone with us.

So, are you ready to take the leap towards a healthier, happier you? Dive into Burnout 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! 🔥

Table of Contents

• Why Choose Burnout?
• Walkthrough
• Application Screenshots:
  • Homepage
  • Profile
  • Events
• Project Techstack:
• Technical Overview:
• Third-Party Dependencies
• Roadmap
• Contributors
• Contribution
• License

💡 Why Choose Burnout?

• Comprehensive Tracking: From what you eat to how much you burn, monitor everything in one place.

• Diverse Fitness Events: Never fall into the monotony of routine. Stay excited about fitness with new events to join regularly.

• Personalized Insights: Understand your body and habits better with data-driven feedback.

• Community Support: Engage with a like-minded community, exchange tips, and stay motivated.

• Security: Your data is precious, and we guard it like our own. Rest assured, your information stays private and secure.

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 Burnout is here to make sure of that.

Walkthrough

Link to the implementation video of the BurnOut application: Video

Application Screenshots

Homepage

Profile

Events

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

Project TechStack

React
MongoDB
Python

Technical Overview

This application is a React-based web application that runs in the user's web browser. It provides the following key features:

• User Authentication: Upon logging in, the application creates and stores tokens locally on the user's machine to maintain user sessions securely.

• Access Control: Authenticated users have access to multiple pages and features within the application, ensuring a personalized and controlled user experience.

• Backend Server: The application relies on a Flask server to serve various user requests. The server interacts with a MongoDB database to fetch and store data as needed, ensuring smooth functionality and data persistence.

With these components working together, the application delivers a secure and feature-rich experience to its users.

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:

• Python
• Node.js

• MongoDB

  Step 1: Git Clone the Repository

  git clone https://github.com/adi-kiran/burnout-healthgoalsapp.git

Step 2: Ensure mongodb is running and execute the below to populate the tables:

python insert_event_data.py
python insert_food_data.py

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

cd backend
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

Third-Party Dependencies

Frontend:

Backend:

Roadmap

• [x] ~Make the pages modular using React~
  • [x] ~Login/SignUp~
  • [x] ~Homepage~
  • [x] ~Events~
  • [x] ~Contact Us~
  • [x] ~Profile~
• [x] ~Allow users to enroll in events~
• [x] ~Generate graphs for user's calories~
• [x] ~Show consumed food history~
• [ ] Include UI testing Framework
• [ ] Allow sharing/exporting user data
• [ ] Dockerise entire application for easy deployment
• [ ] TDEE Calculator

:bulb: Tip: More enhancements/fixes can be found here : https://github.com/adi-kiran/burnout-healthgoalsapp/issues

Contributors

Nimal Sharon Joji

Aditya Kiran

Amrita Visalam

Diksha Maurya

Contribution

Please refer 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 LICENSE for more details.