From 37a5744b2af756ad17eb054eda796d289854eeb3 Mon Sep 17 00:00:00 2001 From: rishi2019194 <58341663+rishi2019194@users.noreply.github.com> Date: Sat, 25 Nov 2023 19:21:27 -0500 Subject: [PATCH] Update README.md Improved Readme further --- README.md | 100 +++++++++++++++++++++++------------------------------- 1 file changed, 43 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index d7d876db..099ba896 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ # 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) - [Core Functionalities of the Application:](#core-functionalities-of-the-application) - [Register, Login, User-Profile](#user-authentication-management-system) @@ -19,14 +20,16 @@ - [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) - [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? +## Why use BurnOut? @@ -70,29 +74,29 @@ Link to the implementation video of the BurnOut application:

-# Core Functionalities of the Application - ## User Authentication Management System +## 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 + ### 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 + ### 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 + ### 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 + ### 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: @@ -102,57 +106,39 @@ Link to the implementation video of the BurnOut application: 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: Follow the remaining steps in the Wiki-page of the repository - https://github.com/rishi2019194/calorieApp/wiki/Installation-and-setup - # 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 - -
- - - - - - - - - - - - - - - -

Utsavkumar Lal

Neha Patil
Ojas Kulkarni

Vighnesh Hegde

Dev Kumar

Prakruthi Somashekar
Radhika Raman

Rohan Sinha

Sunidhi Hegde
-
- - # 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 -

- Report Bug - / - Request Feature -

+## 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/)
+[Ananya Mantravadi](https://www.linkedin.com/in/ananya-mantravadi/)
+[Rishi Singhal](https://www.linkedin.com/in/rishi-singhal1101/)
+[Samarth Shetty](https://www.linkedin.com/in/samarthshetty09/)
+ +## Contact +In case of any issues, please e-mail your queries to calorieapp508@gmail.com 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.