Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Improved Readme asthetics
  • Loading branch information
@rishi2019194
rishi2019194 authored Nov 25, 2023
1 parent 38b47f5 commit 50e455c
Showing 1 changed file with 44 additions and 92 deletions.
136 changes: 44 additions & 92 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,53 +1,45 @@
# walkthrough video:


https://github.com/utsavll0/calorieApp_server/assets/122955760/54f2292f-86fa-4b4b-b263-63d470dcd80b


<br>
<br>

# BurnOut: Your Daily Fitness Companion - Track, Connect, Elevate!

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://gitHub.com/rishi2019194/calorieApp/graphs/commit-activity) [![Contributors Activity](https://img.shields.io/github/commit-activity/m/rishi2019194/calorieApp)](https://github.com/rishi2019194/calorieApp/pulse) [![GitHub issues](https://img.shields.io/github/issues/rishi2019194/calorieApp.svg)](https://github.com/rishi2019194/calorieApp/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues-closed](https://img.shields.io/github/issues-closed/rishi2019194/calorieApp.svg)](https://github.com/rishi2019194/calorieApp/issues?q=is%3Aissue+is%3Aclosed) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/rishi2019194/calorieApp) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/) ![last commit](https://img.shields.io/github/last-commit/rishi2019194/calorieApp) ![github workflow](https://github.com/rishi2019194/calorieApp/actions/workflows/unit_test.yml/badge.svg) ![github workflow](https://github.com/rishi2019194/calorieApp/actions/workflows/style_checker.yml/badge.svg)![github workflow](https://github.com/rishi2019194/calorieApp/actions/workflows/syntax_checker.yml/badge.svg)
[![codecov](https://codecov.io/gh/rishi2019194/calorieApp/branch/main/graph/badge.svg?token=IQW5PLLE22)](https://codecov.io/gh/rishi2019194/calorieApp) [![Running Code Coverage](https://github.com/rishi2019194/calorieApp/actions/workflows/code_cov.yml/badge.svg)](https://github.com/rishi2019194/calorieApp/actions/workflows/code_cov.yml)[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4127507.svg)](https://doi.org/10.5281/zenodo.10023130)[![GitHub release](https://img.shields.io/github/release/rishi2019194/calorieApp.svg)](https://GitHub.com/rishi2019194/calorieAppreleases/) [![StyleCheck: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint) [![HitCount](https://hits.dwyl.com/rishi2019194/calorieApp.svg)](https://hits.dwyl.com/rishi2019194/calorieApp) ![GitHub contributors](https://img.shields.io/github/contributors/rishi2019194/calorieApp) ![GitHub repo size](https://img.shields.io/github/repo-size/rishi2019194/calorieApp)


# BurnOut

![WhatsApp Image 2021-09-28 at 2 48 00 PM](https://user-images.githubusercontent.com/25662536/135546154-cfae1d2e-439a-4edc-b0bb-57f693ef5a83.jpeg)

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. Users can edit their profile by entering their height, weight, goal and target-weight. Users can enroll into numerous programs involving fitness such as yoga classes and workout sessions. Users can now 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. Also, the document aids the developers in understanding the code and acts as a reference point for continuing the project.
**BurnOut is an intuitive fitness application that effortlessly tracks daily calorie intake and expenditure, empowering users to achieve personalized weight goals. With features like profile customization, program enrollment, social connectivity, FitnessBot and BMI-Tracker, BurnOut offers a comprehensive wellness experience, encouraging collaboration and healthy living. This open-source project invites users and developers to enhance its features and contribute to its continuous evolution in the fitness tech space.**

# Table of Contents

- [Why use BurnOut?](#why-use-burnout)
- [Implementation](#implementation)
- [TechStack Used for the Development of Project:](#techstack-used-for-the-development-of-project)
- [Help by using our Software:](#help-by-using-our-software)
- [Core Functionalities of the Application:](#core-functionalities)
- [Register](#register)
- [Login](#login)
- [Set User Profile](#set-user-profile)
- [Enter Calories in and burnt](#enter-calories-in-and-burnt)
- [Check History](#check-history)
- [Adding Friends](#adding-friends)
- [Enrolling into several programs](#enrolling-into-several-programs)
- [Core Functionalities of the Application:](#core-functionalities-of-the-application)
- [Register, Login, User-Profile](#user-authentication-management-system)
- [Enter Calories & Burnout, Graph feature](#user-fitness-tracker)
- [FitnessBot](#fitness-advisor-bot)
- [BMI Calculator](#bmi-tracker-feature)
- [Friends, Enrolled Programs](#collaboration-and-enrollment-feature)
- [Steps for Execution:](#steps-for-execution)
- [Source Code](#source-code)
- [Future Scope](#future-scope)
- [Team Members](#team-members)
- [Contribution](#contribution)
- [License](#license)


# Why use BurnOut?
- 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.
<img src="https://media.giphy.com/media/IAocXiLUK4Y8t28IKC/giphy.gif"
width="30%"
align="right"
/>

**"Burnout"** provides a holistic fitness experience, integrating tracking, guidance, social interaction, diverse fitness plans, BMI assessment, AI assistance, and user-friendly customization for individuals with various fitness goals and levels of experience.
- **Comprehensive Tracking:** Effortlessly monitor calorie intake and expenditure via inputting food details
- **Historical Insights:** View a detailed history of daily calories in and calories burnt out
- **AI-FitnessBot Assistance:** Benefit from AI-driven fitness advice for a tailored and dynamic fitness experience
- **BMI Calculator:** Quickly assess and track your body mass index for a holistic view of your health.
- **Diverse Fitness Plans:** Enroll in various yoga and workout sessions for a customized fitness journey
- **Social Connectivity:** Connect with friends, share progress, and stay motivated together
- **User-Friendly Accessibility:** Accessible to users of all levels with a user-friendly interface

# Implementation

Expand All @@ -60,8 +52,8 @@ Link to the implementation video of the BurnOut application:
<code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_html5/w3_html5-ar21.svg"></a></code>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/CSS" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_css/w3_css-ar21.svg"></a></code> <code><a href="https://www.javascript.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/javascript/javascript-ar21.svg"></a></code>
<code><a href="https://www.jquery.com//" target="_blank"><img height="35" src="https://www.vectorlogo.zone/logos/jquery/jquery-horizontal.svg"></a></code>
<code><a href="https://www.mongodb.com/" target="_blank"><img height="35" src="https://www.vectorlogo.zone/logos/mongodb/mongodb-ar21.svg"></a></code>
<code><a href="https://getbootstrap.com/" target="_blank"><img height="35" src="https://www.vectorlogo.zone/logos/getbootstrap/getbootstrap-ar21.svg"></a></code>
<code><a href="https://www.mongodb.com/" target="_blank"><img height="35" src="https://www.vectorlogo.zone/logos/mongodb/mongodb-ar21.svg"></a></code>
<code><a href="https://flask.palletsprojects.com/en/1.1.x/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/pocoo_flask/pocoo_flask-ar21.svg"></a></code>
<!--<code><a href="https://github.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/github/github-ar21.svg"></a></code>
<code><a href="https://git-scm.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/git-scm/git-scm-ar21.svg"></a></code>
Expand All @@ -77,53 +69,30 @@ Link to the implementation video of the BurnOut application:
<img src="https://media.giphy.com/media/UWt0rhp21JgLwoeFQP/giphy.gif" width ="150"/>
<img src="https://media.giphy.com/media/kH6CqYiquZawmU1HI6/giphy.gif" width ="150"/>
</p>

# Help by using our Software

- With the help of our application, users will get to know the proper analysis of their diet and workout plan.
- The registration form contains the target weight and target date. By filling that, the user will get an analysis in the form of a bar graph based on their past meal intake and burnout. In addition, it also shows how many more calories does the user has to intake or burn.

# Core Functionalities of the Application

## Register

<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/register_page.png>
This is the page where a new user can register to use our application. It contains fields like username, email, password, current weight, current height, target weight which the user wants to achieve and the target date. All these fields, once entered, will store in the MongoDB database.


## Login

<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/login_page.png>
This is the login page wherein the user can access the functionalities of our application.


## Set User Profile

<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/profile_update.png>
This is the page where the user can update his profile. The updated profile will update in the MongoDB database and display it in the frontend.


## Enter Calories in
<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/Calorie_intake.png>
This is the page where the user can enter the calories taken. The dropdown contains various food items and its calories. Once selected, it will update it in the database.


## Check Your Plan

<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/Your_plan_final.jpeg>
This is the page where the user can see their history in the form of a bar graph. This graph contains the data from last 7 days. The user can see their progress and can keep a track of how much calories the user needs to burn or intake to achieve their goal within the target date. The x-axis contains the date from last 7 days to the current date and y-axis contains the calories.


## Adding Friends

<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/friends_tab.png>
- This page contains the list of "My Friends" and "Add friends". Add friends contains all the users who have registered to our application. By selecting the users, they will showup in "My friends" section. The main purpose of this is to share the calories data via email.

## Enter burnout
<img src=https://github.com/utsavll0/calorieApp_server/blob/main/static/img/workout.png>
- This is the page where a user can enter the calories burnt. The value will be updated to the database.
## User Authentication Management System
Via this feature the user can register/log-in to the application and even update his profile at a later stage.
For further reference, refer to the [register](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#register), [log-in](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#login) and [user-profile](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#set-user-profile) pages in the Wiki.

## User Fitness Tracker
Using this feature the user can enter the calories he/she gained or burnt over the period and also keep track of the last 7 seven days calories.
For further reference, refer to the [Enter-Calories](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#enter-calories-in), [Enter-Burnout](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#enter-burnout) and [Your-Plan](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#check-your-plan) pages in the Wiki.

## Fitness Advisor Bot
The fitness advisor bot, i.e., FitnessBot uses OpenAI to recommend the user-fitness advices.
For further reference, refer to the [FitnessBot] page in the Wiki.

## BMI Tracker Feature
As part of BMI-Tracker functionality, the user can calculate his/her BMI and corresponding category and even his/her country's avg BMI.
For further reference, go to the [BMI-Calculator](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#check-your-bmi) page in the Wiki.

## Collaboration and Enrollment Feature
Finally as part of this functionality, the user can connect with new people and share their progress with others via email. Also, they can enroll in different fitness programs.
For further reference, visit the [Friends](https://github.com/rishi2019194/calorieApp/wiki/Core-functionality(Backend)#adding-friends) and the [Enrolled-Plans]() pages in the Wiki.


# Steps for execution
# Steps for execution

Step 1:
Install MongoDB using the following link:
Expand All @@ -140,24 +109,7 @@ This is the page where the user can see their history in the form of a bar graph
https://github.com/deekay2310/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/


# Source Code

Link to the repository:
https://github.com/deekay2310/calorieApp_server
Follow the remaining steps in the Wiki-page of the repository - https://github.com/rishi2019194/calorieApp/wiki/Installation-and-setup

# Enhancements

Expand Down

0 comments on commit 50e455c

Please sign in to comment.