From c6ae022a338a9a39a547d2cce79ebb0a8caf48e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bedirhan=20Ton=C4=9F?= <70720131+bedirhantong@users.noreply.github.com> Date: Thu, 21 Sep 2023 22:31:40 +0300 Subject: [PATCH] Create index.html --- index.html | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..d1ceb02 --- /dev/null +++ b/index.html @@ -0,0 +1,84 @@ + + + + + + Personal Health Tracker + + + + +# Customized Personal Health Tracker + +## Table of Contents + +* [About](#about) +* [Features](#features) +* [Screenshots](#screenshots) +* [Managing](#managing) +* [Technologies](#technologies) +* [Installing Epona](#setup) + + + + + +## About +- EPONA is a personal health tracker Android application. The application allows the user to monitor the performance for various activities such as running, step counting, diving, breath taking. + +- A personal health tracker app build with [Kotlin](https://kotlinlang.org/) and [Firebase](https://firebase.google.com/). + +## Features + +1. `Allows users to login and gain access to the application.` + - If the user has forgotten his/her password, he/she can access his/her account by using only one of the following information: email, phone number or username. +2. `Activity tracking for running, hiking, cycling, and swimming.` + - EPONA is a customised health tracker application for different activities. It gives freedom to the user by offering flexible preference options. +3. `Map tracking during activities.` + - Running activity : EPONA will show the user which paths the user has followed on the map to the current location, how many steps the user has taken in total, average speed, total distance travelled (km), energy consumption and time elapsed while the user is doing the activity. +4. `Log storage for past activities.` + - Before you start any activity in EPONA, EPONA asks you whether you want to keep a record of the activity for history. You can access the statistical data of the activities you have saved days, weeks or even months later. +5. `Detailed user profile with activity statistics.` + - The profile includes a table of the number of steps taken in the current day by hours and a brief summary of the different activities performed during the day. + +## Screenshots + + + + + +## Managing +- When you finish any healthy activity and save it to the history, you will skipping to the [`AddActivitiesAndShowToUser.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/data/AddActivitiesAndShowToUser.kt) to see the statistics of your healthy activity and has an option to save it to the history. +- If you click save button, you will be skipping to the [`ProfileFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/profile/ProfileFragment.kt). In the background I will add it to the `Firestore` with a query. That lists the healthy activities based on their activity type on `Firestore`. +- When you save the activity to the history and skip to the [`ProfileFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/profile/ProfileFragment.kt) you will see that the latest healthy activity that you have done will be show up at the top of previous activities. Same thing happens in [`MainScreenFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/mainPage/MainScreenFragment.kt). How is that possible? + - Skipping to the [`ProfileFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/profile/ProfileFragment.kt) and healthy activity statistic pulling from `Firestore` is happening simultaneously. First I get the statistics of current user. And create an object of [HealthyActivity.kt](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/data/HealthyActivity.kt), after than that I add this healthy activity to the my healthy activity list. So that I can update [`ProfileFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/profile/ProfileFragment.kt) and [HealthyActivity.kt](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/data/HealthyActivity.kt) with using [HealthyActivityAdapter.kt](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/adapter/HealthyActivityAdapter.kt). + - In [HealthyActivityAdapter.kt](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/adapter/HealthyActivityAdapter.kt) you can manage the [recycler_view_activity.xml](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/res/layout/recycler_view_activity.xml) for [`ProfileFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/profile/ProfileFragment.kt) and [`MainScreenFragment.kt`](https://github.com/bedirhantong/PersonalHealthTrackerApp/blob/master/app/src/main/java/com/example/personalhealthtracker/ui/mainPage/MainScreenFragment.kt). + + + +## Technologies + +1. `WilliamChart` : is an Android Library to rapidly implement attractive and insightful charts in android applications. You can see its details [here](https://github.com/diogobernardino/williamchart) +2. `Firebase-firestore` : Implemented it so that I can manage Epona's database without any complex query and database implementation. +3. `Firebase Authentication` : +4. `Material Design Components` : +5. `Easy Permission` : is a wrapper library to simplify basic system permissions logic when targeting Android M or higher. You can see its details [here](https://github.com/googlesamples/easypermissions) +6. `Circular Progress Bar` : allowing to realize a circular ProgressBar in the simplest way possible. You can see the details [here](https://github.com/lopspower/CircularProgressBar) +7. `Shared Preferences` : +8. `Google maps location servies` : To get the current user's current location on the map on live. +9. `Navigation Component` : + +## Setup +- The first thing you need to do is open the project in Android Studio on your own computer using the project's Github link. +- Then you need an unique Google Maps API key. You can get it from [this](https://developers.google.com/maps/documentation/javascript/get-api-key?hl=tr) website. +- If you don't know how to get **Google Maps API key** for this project then you can also use the same link. + - If you get your unique Google Maps API key then you should change the value of **google_maps_key** on ___values.xml___ and ___AndroidManifest.xml___ file. +- If you are all set then you can run the EPONA on your device. +- But you have to restrict your **Google Maps API key** from Google Cloud Platform. [Here](https://developers.google.com/maps/api-security-best-practices?hl=tr) you can learn how to restrict your Map API key for android applications. + +