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/gain. User can edit his profile to enter weight, height and goal. 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. Also, the document aids the developers in understanding the code and acts as a reference point for continuing the project.

Table of Contents

• Why use BurnOut?
• Technologies Used:
• Core Functionalities:
  • Register
  • Login
  • Set User Profile
  • Enter Calories in and burnt
  • Check History
  • User History Plot
• Steps for Execution:
• Source Code
• Additional commands for React App
• Future Scope
• Team Members
• Contribution
• License
• Support

Why use BurnOut?

• User can easily track their calories.
• User just needs to input the food they've had, calories get calculated automatically.
• Record of calories in and calories burn out day wise in History tab.
• Helps user to figure out how much to eat/exercise according to their desired goal(weight loss/gain).
• Easy to use application.

Implementation:

Link to YouTube video of the implementation of the BurnOut application: https://www.youtube.com/watch?v=T0mSCdH9rhU

Technologies Used:

• 
• 
• 
• 
• 
• 
• 

Core Functionalities:

Register

Login

Set User Profile

Enter Calories in and burnt

Check History

User History Plot

We have used python in the backend to track the weight history of a person. We will be deploying a machine learning model to predict the number of days required to achieve his goal in the future scope. This is how to python file works:

1. The data is fetched from MongoDB using the python pymongo library.
2. Fetched data is converted into Pythons Panda Dataframe locally to train the prediction model locally.
3. Weight History line plot for ease in tracking.

Steps for Execution:

• Install MongoDB

• Download and install NodeJs

• Download the Allow CORS: Access-Control-Allow-Origin extension for Google Chrome

• In the command prompt clone the frontend project using following commands:

git clone https://github.com/shantanu109/calorieapp_frontend.git

• Open new console and clone the backend part:

git clone https://github.com/shantanu109/calorieApp_server.git

• Then enter

npm install

to install all the required dependencies in both the terminal. The dependencies have been mentioned in the 'package.json' file.

• Then enter below command for both the terminals to start the application:

npm start

• Open http://localhost:3000 to view it in the browser.

Source Code

• Link to frontend repository: https://github.com/shantanu109/calorieapp_frontend
• Link to backend repository: https://github.com/shantanu109/calorieApp_server

Additional commands for React App

Available Scripts

In the project directory, you can run:

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Future Scope

The below points can be implemented in the future scope of this application:

• Integrate Machine Learning Model with Application to predict the journey to goal and guide the user to it based on previous history.

• Incorporate Field Validations.

• Provide/Create separate pages for the tabs displayed on HomePage.

• Creating pages for Meal and Workout plan.

• Create a mobile application for the web version of the application.

Team Members

• Shantanu Pandey([email protected])

• Sahil Rajesh Nande([email protected])

• Leanne Serrao([email protected])

• Varun Garg([email protected])

• Urmi Kashyap Pathak([email protected])

Contribution

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

License

This project is licensed under the MIT License.

Support

For additional support or inquiries, please contact at [email protected]