|
| 1 | + |
| 2 | +<h1 align="center"> |
| 3 | + <img src="https://user-images.githubusercontent.com/114346679/216282361-ea758c05-756a-48a0-8077-70b5a230f49c.png" width="250" height="166"> |
| 4 | + <br> |
| 5 | + Project Name: Pulse Fit |
| 6 | +</h1> |
| 7 | + |
| 8 | +<div align="center"> |
| 9 | + <strong>Pulse Fit</strong> - One stop destination for all your fitness needs<br> |
| 10 | + CoC Inheritance 2022 || Frontend Warriors <br> <br> |
| 11 | + |
| 12 | +</div> |
| 13 | +<hr> |
| 14 | + |
| 15 | +<details> |
| 16 | +<summary>Table of Contents</summary> |
| 17 | + |
| 18 | +- [Description](#description) |
| 19 | +- [Links](#links) |
| 20 | +- [Tech Stack](#tech-stack) |
| 21 | +- [Progress](#progress) |
| 22 | +- [Future Scope](#future-scope) |
| 23 | +- [Applications](#applications) |
| 24 | +- [Project Setup](#project-setup) |
| 25 | +- [Major Roadblocks](#major-roadblocks) |
| 26 | +- [Usage](#usage) |
| 27 | +- [Team Members](#team-members) |
| 28 | +- [Mentors](#mentors) |
| 29 | +- [Screenshots](#screenshots) |
| 30 | + |
| 31 | +</details> |
| 32 | + |
| 33 | +## 📝Description |
| 34 | + |
| 35 | +<table> |
| 36 | + <tr> |
| 37 | + <td> |
| 38 | + The <strong>Pulse-Fit</strong> is a one stop destination for all ypur fitness related needs |
| 39 | + <br> |
| 40 | + <h3>Access Level</h3> |
| 41 | + The React based web app has one access level |
| 42 | + <h4>Key Features</h4> |
| 43 | + <p> |
| 44 | + <ul> |
| 45 | + <li><strong>BMI Calculator:</strong>The users can calculate their BMI and will get workouts and diet plans suggested according to their health requirement</li> |
| 46 | + <li><strong>Heart Disease Predictor:</strong> Predicts if your heart is healty or at risk of heart diseases</li> |
| 47 | + <li><strong>Find naerby Gyms:</strong> uses google maps API to suggest nearby gyms </li> |
| 48 | + <li><strong>Book Appointments:</strong>Allows users to book doctor's appointments</li> |
| 49 | + <li><strong>Community:</strong>Allows users to share their experiences and build a community</li> |
| 50 | + <li><strong>E-com:</strong>Buy all FItness related products</li> |
| 51 | + </ul> |
| 52 | + </p> |
| 53 | + <h3>Business Potential</h3> |
| 54 | + <p> |
| 55 | + <ul> |
| 56 | + <li>The companies can sell their fitness realted products on the website</li> |
| 57 | + <li>Website can earn add revenue from putting up advertisements</li> |
| 58 | + </ul> |
| 59 | + </p> |
| 60 | + </td> |
| 61 | + </tr> |
| 62 | +</table> |
| 63 | + |
| 64 | +## 🔗Links |
| 65 | + |
| 66 | +- [GitHub Repository](https://github.com/rohanfatehchandka/Inheritance) |
| 67 | +- [Demo Video](https://drive.google.com/file/d/1bnKnUom8AqrgfPURdQmmXl5GzxgywENu/view?usp=sharing) |
| 68 | +- [Drive Link to Screenshots of your project](https://drive.google.com/drive/folders/1hZTCHkw_yaMnJ_c1jsrRcVmwoz0eGZFA?usp=sharing) |
| 69 | +- [Hosted Website Link](https://frontend-fw.vercel.app/) |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +Add any more links/resources you used for your project |
| 74 | + |
| 75 | +## 🤖Tech-Stack |
| 76 | + |
| 77 | +Mention all languages/libraries/frameworks used in your project **domain-wise** |
| 78 | +You can use icons too - find them [here](https://github.com/get-icon/geticon) |
| 79 | + |
| 80 | +- **Server:** ,      |
| 81 | +- **Client:**   |
| 82 | + |
| 83 | + |
| 84 | +## 📈Progress |
| 85 | + |
| 86 | + fully implemented features : |
| 87 | + |
| 88 | +- [x] BMI calculator : will calculate the bmi of a person and will suggest videos and diet tips. |
| 89 | +- [x] Heart Disease Predictor : taking some information about habits of the user our predictor can predit if the user's heart is healthy or at risk of heart disease in future |
| 90 | +- [x] Book Doctor's appointment : user can pre-book Doctor's appointment. |
| 91 | +- [x] Ecommerce : user can buy all fitness realted products here |
| 92 | +- [x] Community : All users of the website can communicate with each other. |
| 93 | +- [x] Map : To find nearby gyms |
| 94 | +- [x] Login & sign-up : secure login and sigh-up using jwt tokens |
| 95 | +- [x] Contact us: The user can contact us using this feature.It sends automated E-mails |
| 96 | + |
| 97 | +## 🔮Future Scope |
| 98 | +- Additional access level: An additional acces level for the admin who can manage the website |
| 99 | +- Improving the accuracy of Heart Disease Predictor : Currently the accuracy of the model is 85%. Training the model to increase the accuracy |
| 100 | +- Payment checkout for E-commerce part of the website |
| 101 | + |
| 102 | +## 💸Applications |
| 103 | +- Pulse Fit is capable to host products of many health-realted buisnesses in the E-com part of our website |
| 104 | +- It can earn add revenue from putting up advertisements |
| 105 | +- Our website contains various features and we aim at meeting all the fitness related needs |
| 106 | + |
| 107 | +## 🛠Project Setup |
| 108 | + |
| 109 | +For the Web-App |
| 110 | +1.Clone the GitHub repo |
| 111 | +```bash |
| 112 | +git clone https://github.com/Bruhbytes/Frontend-Warriors.git |
| 113 | +``` |
| 114 | +2.Enter the client directory. Install all the required dependencies. |
| 115 | +```bash |
| 116 | + cd frontend |
| 117 | + npm install |
| 118 | + npm start |
| 119 | +``` |
| 120 | +3.To start the backend server: |
| 121 | +```bash |
| 122 | + cd backend |
| 123 | + npm install |
| 124 | + npm run dev |
| 125 | +``` |
| 126 | +## 🚧Major Roadblocks |
| 127 | +1. material-ui has a peer dependency conflict with React |
| 128 | + ``` |
| 129 | + npm ERR! code ERESOLVE |
| 130 | + npm ERR! ERESOLVE unable to resolve dependency tree |
| 131 | + npm ERR! |
| 132 | + npm ERR! While resolving: [email protected] |
| 133 | + |
| 134 | + npm ERR! node_modules/react |
| 135 | + npm ERR! react@"^17.0.1" from the root project |
| 136 | + npm ERR! |
| 137 | + npm ERR! Could not resolve dependency: |
| 138 | + npm ERR! peer react@"^16.8.0" from @material-ui/[email protected] |
| 139 | + npm ERR! node_modules/@material-ui/core |
| 140 | + npm ERR! @material-ui/core@"*" from the root project |
| 141 | + npm ERR! |
| 142 | + npm ERR! Fix the upstream dependency conflict, or retry |
| 143 | + npm ERR! this command with --force, or --legacy-peer-deps |
| 144 | + npm ERR! to accept an incorrect (and potentially broken) dependency resolution. |
| 145 | + npm ERR! |
| 146 | + npm ERR! See /Users/jordanhilado/.npm/eresolve-report.txt for a full report. |
| 147 | +
|
| 148 | + npm ERR! A complete log of this run can be found in: |
| 149 | + npm ERR! /Users/jordanhilado/.npm/_logs/2020-10-31T17_57_54_724Z-debug.log |
| 150 | + ``` |
| 151 | + Solution: |
| 152 | + ``` |
| 153 | + npm install -f @material-ui/core |
| 154 | + ``` |
| 155 | + |
| 156 | +## 💻Usage |
| 157 | + |
| 158 | +>Steps to run your project once its setup. |
| 159 | +- login/Sign-up: Login to the website using your credentials.If you are a new user u can sign-up using your e-mail id and set up a secure password (for ex. [email protected] ,password :Rohan@12345) |
| 160 | +- All the features are listed on the navbar can be used |
| 161 | + <h4>BMI</h4> |
| 162 | + <p> |
| 163 | + <ul> |
| 164 | + <li>click the BMI tab on navbar you will be directed to a page where at the bottom you will find a button "Calculate BMI" click to find your BMI </li> |
| 165 | + <li>Fill the form and click submit</li> |
| 166 | + <li>Your BMI along with suggested diet plans and videos will be displayed </li> |
| 167 | + </ul> |
| 168 | + </p> |
| 169 | + <h4>heart</h4> |
| 170 | + <p> |
| 171 | + <ul> |
| 172 | + <li>click the heart tab on navbar you will be directed to a form </li> |
| 173 | + <li>Fill the form and click submit</li> |
| 174 | + <li>Your heart health will be displayed </li> |
| 175 | + </ul> |
| 176 | + </p> |
| 177 | + <h4>findNearbyGyms</h4> |
| 178 | + <p> |
| 179 | + <ul> |
| 180 | + <li>click the findNearbyGym tab on navbar you will be directed to a page </li> |
| 181 | + <li>click on the compass at the top </li> |
| 182 | + <li>Gyms nearby you will be visible on the map</li> |
| 183 | + </ul> |
| 184 | + </p> |
| 185 | + <h4>Community</h4> |
| 186 | + <p> |
| 187 | + <ul> |
| 188 | + <li>click the community tab on navbar you will be directed to the community page </li> |
| 189 | + <li>you will see messages from other users of our website</li> |
| 190 | + <li>To post on the community page you will see a box at the bottom type your message there and click submit </li> |
| 191 | + </ul> |
| 192 | + </p> |
| 193 | + <h4>Appointment</h4> |
| 194 | + <p> |
| 195 | + <ul> |
| 196 | + <li>click the Appointment tab on navbar you will be directed to a form </li> |
| 197 | + <li>fill in the details </li> |
| 198 | + <li>choose your slot</li> |
| 199 | + <li>you cannot book a slot for the next 24hrs if it is already booked by someone </li> |
| 200 | + <li>slots get vacant everyday</li> |
| 201 | + <li>Thus, one can book a slot for the coming day only</li> |
| 202 | + </ul> |
| 203 | + </p> |
| 204 | + <h4>Shop</h4> |
| 205 | + <p> |
| 206 | + <ul> |
| 207 | + <li>click the Shop on navbar you will be directed to our shop </li> |
| 208 | + <li> the prodiucts are divided into three categories :clothes,equipments and suppliments </li> |
| 209 | + <li> click on shop now on there you will be directed to pages thus products are filtered </li> |
| 210 | + <li>below these categories you will see popular products</li> |
| 211 | + <li>click on the middle icon of any product you wish to view ,which is visible on hovering over the product </li> |
| 212 | + <li>you can now see the product choose quantity of the product you wish to buy</li> |
| 213 | + <li>click on add to cart button</li> |
| 214 | + <li>On the top right corner you will see a cart icon click on it to view your cart</li> |
| 215 | + <li>Fill in your address and phone no. oh the right hand side of the page and click submit</li> |
| 216 | + <li>Your order is placed</li> |
| 217 | + |
| 218 | + </ul> |
| 219 | + </p> |
| 220 | + <h4>Contact Us</h4> |
| 221 | + <p> |
| 222 | + <ul> |
| 223 | + <li>click the contactus tab on navbar you will be directed to a form </li> |
| 224 | + <li>fill in the details </li> |
| 225 | + <li>we will recieve your feedback/message</li> |
| 226 | + <li>you will recieve a confirmation email</li> |
| 227 | + |
| 228 | + </ul> |
| 229 | + </p> |
| 230 | + |
| 231 | + |
| 232 | +## 👨💻Team Members |
| 233 | + |
| 234 | + - [Rohan Fatehchandka ](https://github.com/rohanfatehchandka) : [email protected] |
| 235 | + - [Tanaya Shelke ](https://github.com/tanayaa1) : [email protected] |
| 236 | + - [Om Doiphode ](https://github.com/Om-Doiphode) : [email protected] |
| 237 | + |
| 238 | + |
| 239 | +## 👨🏫Mentors |
| 240 | + - [Harsh Nag](https://github.com/Jigsaw-23122002) |
| 241 | + - [Devansh Joshi](https://github.com/devdev29) |
| 242 | + |
| 243 | +## 📱Screenshots |
| 244 | +- Home page preview: |
| 245 | + |
| 246 | + |
| 247 | +- login/sign-up |
| 248 | + |
| 249 | + |
| 250 | +- Heart disease predictor |
| 251 | + |
| 252 | + |
| 253 | + |
| 254 | +- BMI calculator  |
| 255 | + |
| 256 | +- shop |
| 257 | + |
| 258 | + |
| 259 | + |
| 260 | +- Appointment: |
| 261 | + |
| 262 | +- find nearby gyms: |
| 263 | + |
| 264 | +- community: |
| 265 | + |
| 266 | + |
| 267 | +- contact us |
| 268 | + |
0 commit comments