-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9456141
commit 6bbd210
Showing
1 changed file
with
85 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| <h1 align="center">CycloFit</h1> | ||
|
|
||
|
|
||
| ## Index | ||
| <ul> | ||
| <li><a href="#index1">About the Project</a><br> | ||
| </li> | ||
| <li><a href="#index2">Features</a><br> | ||
| </li> | ||
| <li><a href="#index3">How to SetUp</a><br> | ||
| </li> | ||
| <li><a href="#index4">Tech Used</a><br> | ||
| </li> | ||
| <li><a href="#index5">Permissions</a><br></li> | ||
| <li><a href="#index6">Requirements</a><br></li> | ||
|
|
||
| <li><a href="#index7">App Screenshots</a><br> | ||
| </li> | ||
| <li><a href="#index8">Contribute</a><br></li> | ||
| <li><a href="#index9">Show your support</a><br></li> | ||
| </ul> | ||
|
|
||
| <p><h2><a id="index1"></a>About The Project</h2></p> | ||
| Cyclofit is a safety and health monitoring system for cyclists. <br><br> | ||
| It tracks the heart rate,calories burnt, distance coverered and much more using the sensors integrated in a single device.Our device has a proximity sensor that can track | ||
| any incoming vehicle by monitoring it's rate of change of speed. The data such as the heart rate are displayed into the app through an api. | ||
|
|
||
| <p><h2><a id="index2"></a>✨ Features</h2></p> | ||
| Our app has many essential features to track and analyse the performance of a cyclist: <br><br> | ||
| 1. The Home page of our app has a timer that tracks the calories burnt in that given time. <br><br> | ||
| 2. We have a community page that allows a user to create and join a community which allows him to track everything that has been cooking in that particular community<br><br> | ||
| 3. The Health section provides the cyclists with an overview of everything that our app has to offer. There a 3 graphs in this particular section to visualise the data in a more effective manner<br><br> | ||
| 4. A leaderboard allows the user to see where he stands in comparison to his peers | ||
|
|
||
| <p><h2><a id="index3"></a>🛠 How To Setup</h2></p> | ||
| <p><a href="https://drive.google.com/file/d/1jqkUbAq27tozCXRK3JkrfvH0Q6uczOQZ/view?usp=share_link">Click Here Download the apk</a>. After that install the apk file, the app will start installing on your device (minimum requirement of device is Android 5.0). Once the appis installed, click on open the app, your app will open then your are good to go, app is ready for its use.</p> | ||
|
|
||
| <p><h2><a id="index4"></a>👨💻 Tech Stack</h2></p> | ||
| **Backend** | ||
| - Kotlin | ||
| - Firebase | ||
|
|
||
| **Frontend** | ||
| - Lottie Animation Library | ||
| - Material Design Components | ||
| - Chip Navigation Bar | ||
|
|
||
| <p><h2><a id="index5"></a>❕ Permissions</h2></p> | ||
| - Read External Storage <br/> | ||
| - Internet | ||
|
|
||
|
|
||
| <p><h2><a id="index6"></a>⛏ Requirements</h2></p> | ||
|
|
||
| - Android version 5.0 and above | ||
| - Minimum API Version: 21 | ||
|
|
||
| <p><h2><a id="index7"></a>🖼 App Screenshots</h2></p> | ||
| <table> | ||
| <tr> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205489866-a1c1f910-262c-4b3a-bed5-df510a56c3ae.jpg" width=250 height=480></td> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205489863-4a65f6a3-b127-429d-8557-085b7ec527c2.jpg" width=250 height=480></td> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205490218-4ff64999-57a9-4189-a922-d8eced6045bd.jpeg" width=250 height=480></td> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205490042-5f6ad1b3-6e4c-40e6-b4d9-d833dab08a7f.jpg" width=250 height=480></td> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205489861-c59e861f-133b-4da8-b17a-23819b4d3845.jpg" width=250 height=480></td> | ||
| <td><img src="https://user-images.githubusercontent.com/90026952/205490219-4efb4f6b-b8f2-4430-9824-df7581b0b113.jpeg" width=250 height=480></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <p><h2><a id="index8"></a>🤝 Contribute</h2></p> | ||
| <p>Contributions are always welcome! Please create a PR to make a contribution.</p> | ||
|
|
||
|
|
||
| <p><h2><a id="index9"></a>❤ Show your support</h2></p> | ||
| <p>Give a <g-emoji class="g-emoji" alias="star" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2b50.png">⭐️</g-emoji> if this project helped you!</p> | ||
|
|
||
| ⚒ Built by [Aditya Gupta][linAjay] | [Pratyush Singh][linPriyam] with ♥ | ||
|
|
||
| [MDC]:https://material.io/ | ||
| [lottie]:https://airbnb.io/lottie/ | ||
| [mdc]:https://material.io/develop/android | ||
| [linAjay]:https://www.linkedin.com/mwlite/in/aditya-gupta-009520226 | ||
| [linPriyam]:https://www.linkedin.com/in/pratyush-singh-9323ab20a/ |