forked from utsavll0/calorieApp_server
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36 from rishi2019194/readme_branch
- Loading branch information
Showing
1 changed file
with
81 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,63 @@ | ||
| # 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! | ||
|
|
||
| [](https://gitHub.com/rishi2019194/calorieApp/graphs/commit-activity) [](https://github.com/rishi2019194/calorieApp/pulse) [](https://github.com/rishi2019194/calorieApp/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/rishi2019194/calorieApp/issues?q=is%3Aissue+is%3Aclosed)  [](http://makeapullrequest.com) [](https://opensource.org/licenses/MIT) [](https://www.python.org/) [](https://www.python.org/dev/peps/pep-0008/)    | ||
| [](https://codecov.io/gh/rishi2019194/calorieApp) [](https://github.com/rishi2019194/calorieApp/actions/workflows/code_cov.yml)[](https://doi.org/10.5281/zenodo.10023130)[](https://GitHub.com/rishi2019194/calorieAppreleases/) [](https://github.com/pylint-dev/pylint) [](https://hits.dwyl.com/rishi2019194/calorieApp)   | ||
|
|
||
|
|
||
| # BurnOut | ||
|
|
||
|  | ||
|
|
||
| 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) | ||
| - [Project Documentation](#project-documentation) | ||
| - [Project Presentation Video](#project-presentation-video) | ||
| - [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) | ||
| - [Enhancements Done in the Project](#enhancements-done-in-the-project) | ||
| - [Steps for Execution:](#steps-for-execution) | ||
| - [Source Code](#source-code) | ||
| - [Future Scope](#future-scope) | ||
| - [Team Members](#team-members) | ||
| - [Contribution](#contribution) | ||
| - [Contribute](#contribute-to-the-project) | ||
| - [Team Members](#contributors) | ||
| - [Contact](#contact) | ||
| - [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. | ||
| ## Why use BurnOut? | ||
| <img src="https://media.giphy.com/media/IAocXiLUK4Y8t28IKC/giphy.gif" | ||
| width="30%" | ||
| align="right" | ||
| /> | ||
|
|
||
| # Implementation | ||
| **"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 | ||
|
|
||
| Link to the implementation video of the BurnOut application: | ||
| ## Project Documentation | ||
|
|
||
| ## Project Presentation Video | ||
|
|
||
|
|
||
| # TechStack Used for the Development of Project | ||
|
|
||
|
|
||
| ## TechStack Used for the Development of Project | ||
|
|
||
| <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> | ||
|
|
@@ -77,53 +73,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. | ||
|
|
||
| ## Core Functionalities of the Application | ||
| ### 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. | ||
|
|
||
|
|
||
| ## 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. | ||
|
|
||
| # Steps for execution | ||
| ## Steps for execution | ||
|
|
||
| Step 1: | ||
| Install MongoDB using the following link: | ||
|
|
@@ -133,74 +106,39 @@ This is the page where the user can see their history in the form of a bar graph | |
| Step 2: | ||
| Git Clone the Repository | ||
|
|
||
| git clone https://github.com/deekay2310/calorieApp_server.git | ||
| git clone https://github.com/rishi2019194/calorieApp_server.git | ||
|
|
||
| (OR) Download the .zip file on your local machine | ||
|
|
||
| https://github.com/deekay2310/calorieApp_server.git | ||
| https://github.com/rishi2019194/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 | ||
| Follow the remaining steps in the Wiki-page of the repository - https://github.com/rishi2019194/calorieApp/wiki/Installation-and-setup | ||
|
|
||
| Link to the repository: | ||
| https://github.com/deekay2310/calorieApp_server | ||
|
|
||
| # Enhancements | ||
|
|
||
| 1. Make the website view port adaptable - the website should look good on phone, tablet and computer. | ||
| 2. Chatbot to guide through the application. | ||
| 3. Share workout plans with friends via email. | ||
| 4. Bug Fixes | ||
|
|
||
|
|
||
| # Contributers | ||
|
|
||
| <center> | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/utsavll0"><img src="https://avatars.githubusercontent.com/utsavll0" width="100px;" alt=""/><br /><sub><b>Utsavkumar Lal</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/neha7799"><img src="https://avatars.githubusercontent.com/neha7799" width="100px;" alt=""/><br /><sub><b>Neha Patil</b></sub></a></td> | ||
| <td align="center"><a href="https://github.com/ojas1901"><img src="https://avatars.githubusercontent.com/ojas1901" width="100px;" alt=""/><br /><sub><b>Ojas Kulkarni</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/Viggy12126"><img src="https://avatars.githubusercontent.com/Viggy12126" width="100px;" alt=""/><br /><sub><b>Vighnesh Hegde</b></sub></a><br /></td> | ||
| </tr> | ||
| <tr> | ||
| <tr><td></td></tr> | ||
| <td align="center"><a href="https://github.com/deekay2310"><img src="https://avatars.githubusercontent.com/u/29257773?v=4" width="100px;" alt=""/><br /><sub><b>Dev Kumar</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/PrakruthiSomashekar"><img src="https://avatars.githubusercontent.com/u/62984587?v=4" width="100px;" alt=""/><br /><sub><b>Prakruthi Somashekar</b></sub></a></td> | ||
| <td align="center"><a href="https://github.com/radhikaraman20"><img src="https://avatars.githubusercontent.com/u/89432698?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Radhika Raman</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/RohanSinha96"><img src="https://avatars.githubusercontent.com/u/15325746?v=4" width="100px;" alt=""/><br /><sub><b>Rohan Sinha</b></sub></a><br /></td> | ||
| <td align="center"><a href="https://github.com/SunidhiHegde"><img src="https://avatars.githubusercontent.com/u/62884191?v=4" width="100px;" alt=""/><br /><sub><b>Sunidhi Hegde</b></sub></a><br /></td> | ||
| </tr> | ||
| </table> | ||
| </center> | ||
|
|
||
| # Contribution | ||
|
|
||
| Please refer the [CONTRIBUTING.md](https://github.com/deekay2310/calorieApp_server/blob/main/CONTRIBUTING.md) file for instructions on how to contribute to our repository. | ||
| ## Enhancements Done In the Project | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/deekay2310/calorieApp_server/issues/new/choose">Report Bug</a> | ||
| / | ||
| <a href="https://github.com/deekay2310/calorieApp_server/issues/new/choose">Request Feature</a> | ||
| </p> | ||
| ## Future Scope | ||
| ## Contribute to the Project! | ||
|
|
||
| # License | ||
|
|
||
| This project is licensed under the MIT License. | ||
|
|
||
| Please refer to the [CONTRIBUTING.md](https://github.com/rishi2019194/calorieApp/blob/main/CONTRIBUTING.md) if you want to contribute to the PopcornPicks source code. Follow all the guidelines mentioned in the same and raise a pull request, we would love to look at it ❤️❤️! | ||
|
|
||
| ## Contributors | ||
| [Aditya Pai Brahmavar](https://www.linkedin.com/in/adityapai16/)<br/> | ||
| [Ananya Mantravadi](https://www.linkedin.com/in/ananya-mantravadi/)<br/> | ||
| [Rishi Singhal](https://www.linkedin.com/in/rishi-singhal1101/)<br/> | ||
| [Samarth Shetty](https://www.linkedin.com/in/samarthshetty09/)<br/> | ||
|
|
||
| ## Contact | ||
| In case of any issues, please e-mail your queries to [email protected] or raise an issue on this repository. | ||
|
|
||
| ## Join the BurnOut Community: | ||
| Contribute to the project and help us refine fitness goals. | ||
| Share your workout experiences and wellness achievements with us. | ||
| Together, let's make BurnOut the ultimate fitness companion! | ||
| BurnOut is more than just an app; it's a commitment to a healthier lifestyle, and we invite you to be a part of this empowering journey. Start tracking, connecting, and achieving your fitness goals like never before with BurnOut! | ||
| Let's make wellness journeys extraordinary together!" | ||
|
|
||
| ## License | ||
| This project is under the MIT License. | ||
|
|
||
|
|
||