BurnOut is an easy to use application that keeps track of a user's daily calories - gained and burnt. It can help the user to set goals such as weight loss or gain. Users can edit their profile by entering their height, weight, goal and targeted-weight. Users can enroll into numerous programs involving fitness such as yoga classes and workout sessions. They can also connect with their friends by sending a friend-request and share their progress. This document provides a major perspective for the users to understand and take up the project as an Open source software and add on multiple features before releasing to the market. This repo aids the developers in understanding the code and acts as a reference point for continuing the project.
- Written unit tests with proper mocking and increased the code coverage from 56% to 98%
- Deployed local mongo server to MongoAtlas
- Added Linter and Code formatter in the CI pipeline
- Added Software Documentation
- Improved Contributing.md
- Why use BurnOut?
- Implementation
- TechStack Used for the Development of Project:
- Core Functionalities of the Application:
- Steps for Execution:
- Source Code
- Future Scope
- Team Members
- Contribution
- License
- User can keep a track of their calorie intake.
- User just needs to input the food they've had, calories get calculated automatically.
- Displays a record of calories in and calories burnt out day wise in History tab.
- Helps user to figure out how much to eat/exercise according to their desired goal(weight loss/gain).
- Users can connect with their friends and keep track of each other's progress
- Enrollment into numerous yoga and workout sessions.
- Accessible to everyone and easy to use.
Link to the implementation video of the BurnOut application:
BURNOUT.mp4
MongoDB
CSS3
HTML 5
BURNOUT.register.mp4
BURNOUT.login.copy.mp4
BURNOUT.user_profile.mp4
BURNOUT.calories.mp4
BURNOUT.history.mp4
We have used python in the backend to fetch the current weight and goal weight of a person from python collection. We have also implemented a diet recommendation model which gives the user a 30 day diet plan stored in diet_guide.txt and intend to integrate this with the application in the further stage of this project. The graphs below demonstrate weight loss prediction if the diet is followed as prescribed.
BURNOUT.friends.mp4
BURNOUT.enroll.mp4
Step 1: Install MongoDB using the following link:
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows
Step 2: Git Clone the Repository
git clone https://github.com/atharva1996/calorieApp_server.git
(OR) Download the .zip file on your local machine
https://github.com/atharva1996/calorieApp_server.git
Step 3: Install the required packages by running the following command in the terminal
pip install -r requirements.txt
Step 4: Run the following command in the terminal
python application.py
Step 5:
Open the URL in your browser:
http://127.0.0.1:5000/
The following features can be implemented in the future scope of this application:
- Predicting workout plans for users based on their history and fitness reports.
- Create a mobile application for the web version of the application.
- Make the website view port adaptable - the website should look good on phone, tablet and computer.
- Chat functionality for friends
- Share workout plans with friends
- Creating an Activities dashboard based on user enrollment
- Track user progress for each activity he/she enrolled for.
Please refer the CONTRIBUTING.md file for instructions on how to contribute to our repository.
This project is licensed under the MIT License.