From 7f8ae68f3423beba2088e9bfb64567dbdab0aa79 Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:09:19 -0400 Subject: [PATCH 01/12] Added Description Title --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1055867..c8b475c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ ![build-release](https://github.com/arafaysaleem/covid_tracker/workflows/build-release/badge.svg) ![Test PR](https://github.com/arafaysaleem/covid_tracker/workflows/Test%20PR/badge.svg) [![GitHub release](https://img.shields.io/github/release/arafaysaleem/covid_tracker?color=blue)](https://github.com/arafaysaleem/covid_tracker/releases) [![GitHub stars](https://img.shields.io/github/stars/arafaysaleem/covid_tracker?color=orange)](https://github.com/arafaysaleem/covid_tracker/stargazers) [![GitHub issues](https://img.shields.io/github/issues/arafaysaleem/covid_tracker?color=red)](https://github.com/arafaysaleem/covid_tracker/issues) [![GitHub issues](https://img.shields.io/github/issues-closed/arafaysaleem/covid_tracker?color=brightgreen)](https://github.com/arafaysaleem/covid_tracker/issues?q=is%3Aissue+is%3Aclosed) [![GitHub forks](https://img.shields.io/github/forks/arafaysaleem/covid_tracker?color=yellow)](https://github.com/arafaysaleem/covid_tracker/network) [![License: MIT](https://img.shields.io/github/license/arafaysaleem/covid_tracker)](https://github.com/arafaysaleem/covid_tracker/blob/master/LICENSE) [![made-with-python](https://img.shields.io/badge/Made%20With-Flutter-blue)](https://flutter.dev/) -Covid Tracker is an Android app made with **Flutter** framework to provide worldwide information related to Covid-19 pandemic. The intended use of this app is to provide the public with honest and easy-to-navigate information regarding Covid-19. Providing users with this information can help lessen the spread of Covid-19 and inform users about how to stay safe. +## Description +Covid Tracker is an Android app made with **Flutter** framework to provide worldwide information related to The Covid-19 pandemic. The intended use of this app is to provide the public with honest and easy-to-navigate information regarding Covid-19. Providing users with this information can help lessen the spread of Covid-19 and inform users about how to stay safe. The api used for the data can be found [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** From 693d8bfde3c9290de6ee842c3737f467c17c1e41 Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:18:13 -0400 Subject: [PATCH 02/12] Added Description Title From 631e0d7323a9561cff50dd3f399985f748d8528e Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:21:03 -0400 Subject: [PATCH 03/12] Condensed Description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8b475c..3dd304e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![build-release](https://github.com/arafaysaleem/covid_tracker/workflows/build-release/badge.svg) ![Test PR](https://github.com/arafaysaleem/covid_tracker/workflows/Test%20PR/badge.svg) [![GitHub release](https://img.shields.io/github/release/arafaysaleem/covid_tracker?color=blue)](https://github.com/arafaysaleem/covid_tracker/releases) [![GitHub stars](https://img.shields.io/github/stars/arafaysaleem/covid_tracker?color=orange)](https://github.com/arafaysaleem/covid_tracker/stargazers) [![GitHub issues](https://img.shields.io/github/issues/arafaysaleem/covid_tracker?color=red)](https://github.com/arafaysaleem/covid_tracker/issues) [![GitHub issues](https://img.shields.io/github/issues-closed/arafaysaleem/covid_tracker?color=brightgreen)](https://github.com/arafaysaleem/covid_tracker/issues?q=is%3Aissue+is%3Aclosed) [![GitHub forks](https://img.shields.io/github/forks/arafaysaleem/covid_tracker?color=yellow)](https://github.com/arafaysaleem/covid_tracker/network) [![License: MIT](https://img.shields.io/github/license/arafaysaleem/covid_tracker)](https://github.com/arafaysaleem/covid_tracker/blob/master/LICENSE) [![made-with-python](https://img.shields.io/badge/Made%20With-Flutter-blue)](https://flutter.dev/) ## Description -Covid Tracker is an Android app made with **Flutter** framework to provide worldwide information related to The Covid-19 pandemic. The intended use of this app is to provide the public with honest and easy-to-navigate information regarding Covid-19. Providing users with this information can help lessen the spread of Covid-19 and inform users about how to stay safe. +Covid Tracker, an Android app built with **Flutter** framework provides global Covid-19 pandemic information to the public, promoting awarness and safety. The api used for the data can be found [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** From cd9aa06509122b9969fbde2ae3b14b5f064a30db Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:56:15 -0400 Subject: [PATCH 04/12] Condensed API Link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dd304e..d494ede 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Description Covid Tracker, an Android app built with **Flutter** framework provides global Covid-19 pandemic information to the public, promoting awarness and safety. -The api used for the data can be found [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** +API used for data [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** ## :iphone: Features From c735cb2787c601ce97a05c640bae9cf0dead0655 Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Wed, 27 Sep 2023 17:57:33 -0400 Subject: [PATCH 05/12] Got Rid of Logos --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d494ede..8ddaf5a 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147 -## ⭐ Future Features +## Future Features - Drawer for easier navigation - Onboarding screens @@ -36,7 +36,7 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147 *Feel free to fork and contribute to include these features.* ❤︎ -## 🚀 Technologies +## Technologies - [Flutter v1.17.4](https://storage.googleapis.com/flutter_infra/releases/stable/windows/flutter_windows_1.17.4-stable.zip) - Flutter is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase. @@ -50,7 +50,7 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147 - Dart - [Get Dart](https://dart.dev/get-dart) - Flutter - [Get Started](https://docs.flutter.dev/get-started/install) -## 🧠 Further Information +## Further Information Currently, this app is not available for public download on the Android app store. However, if you would like to see how the current features work, we recommend these steps: @@ -62,11 +62,11 @@ If anyone would like to add other ways of viewing the app in its current state, As mentioned previously, this application is only available for Android devices. However, we are working to include an IOS version. You can find the working folder for the IOS version under "ios". -## 🤝 Contribute +## Contribute To contribute, fork the repository and push the changes to the **master** branch. Then submit a pull request for merging with the source. If your code passes the review and checks it will be merged into the master branch. -## 💌 To Do +## To Do 1. Find new API to draw data from 2. Add future features (can be found above) @@ -74,7 +74,7 @@ To contribute, fork the repository and push the changes to the **master** branch 4. Create plan to have first version on the Android app store 5. Continue with IOS version -## 💬 Feedback +## Feedback Feel free to send us feedback on [Twitter](https://twitter.com/gitpointapp) or [file an issue](https://github.com/arafaysaleem/covid_tracker/issues/new). Feature requests are always welcome. From 7ad57114d3289d0a99564969c27b69358a0ca169 Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Thu, 28 Sep 2023 13:30:55 -0400 Subject: [PATCH 06/12] Updated Features --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8ddaf5a..f4a1875 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,11 @@ API used for data [here](https://corona.lmao.ninja/docs/). **The release apk is ## :iphone: Features - - Global case count. - - Case, death and recovery count of each country - - Total tests and infection probability of each country - - News updates related to vaccine developement - - Info, symptoms, precautions and myths of the virus - - Setting a default country + - Worldwide case count + - Individual country statistics for cases, deaths, and recoveries + - Comprehensive data on total tests and infection probabilies for each nation + - Timely news updates on vaccine developements + - Detailed information on the virus The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147-Coronavirus-Covid-19-Dashboard) (credits to [Nazirul Hoque](https://dribbble.com/nazirulhoque) on Dribble). From 8ba98b49f281783cc8f0d6db3e8ca51f96a495fa Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Thu, 28 Sep 2023 13:43:34 -0400 Subject: [PATCH 07/12] Added Prereq & Installation Got rid of "Technologies" and sub header of "How to start with Flutter and Dart" just to categorize everything and make it simpler to read. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f4a1875..4cbf8cf 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,17 @@ Covid Tracker, an Android app built with **Flutter** framework provides global C API used for data [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** +## Prerequisites + - [Flutter v1.17.4](https://storage.googleapis.com/flutter_infra/releases/stable/windows/flutter_windows_1.17.4-stable.zip)- An open source framework by Google for building multi-platform applications from a single codebase. + - [Dart v2.8.4](https://dart.dev/get-dart) - Helps develop Dart web, command-line, and server apps. + +## Installation +Note: Download the versions mentioned above for Flutter and Dart for the code to work since a different version might cause some issues. + + First Download Get and then install FLutter. + - Dart - [Get Dart](https://dart.dev/get-dart) + - Flutter - [Get Started](https://docs.flutter.dev/get-started/install) + ## :iphone: Features - Worldwide case count @@ -34,20 +45,9 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147 - Maps API to detect nearby danger spots *Feel free to fork and contribute to include these features.* ❤︎ - -## Technologies - - - [Flutter v1.17.4](https://storage.googleapis.com/flutter_infra/releases/stable/windows/flutter_windows_1.17.4-stable.zip) - - Flutter is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase. - - [Dart v2.8.4](https://dart.dev/get-dart) - - Dart SDK helps develop Dart web, command-line, and server apps. ### How to start with Flutter and Dart - Note: Download the versions mentioned above for Flutter and Dart for the code to work since a different version might cause some issues. - First Download Get and then install FLutter. - - Dart - [Get Dart](https://dart.dev/get-dart) - - Flutter - [Get Started](https://docs.flutter.dev/get-started/install) ## Further Information From d48f5c6219299b4c44f6593f84cd911a8b16a58e Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Thu, 28 Sep 2023 13:50:08 -0400 Subject: [PATCH 08/12] Added Table of Contents --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4cbf8cf..104542d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,19 @@ ![build-release](https://github.com/arafaysaleem/covid_tracker/workflows/build-release/badge.svg) ![Test PR](https://github.com/arafaysaleem/covid_tracker/workflows/Test%20PR/badge.svg) [![GitHub release](https://img.shields.io/github/release/arafaysaleem/covid_tracker?color=blue)](https://github.com/arafaysaleem/covid_tracker/releases) [![GitHub stars](https://img.shields.io/github/stars/arafaysaleem/covid_tracker?color=orange)](https://github.com/arafaysaleem/covid_tracker/stargazers) [![GitHub issues](https://img.shields.io/github/issues/arafaysaleem/covid_tracker?color=red)](https://github.com/arafaysaleem/covid_tracker/issues) [![GitHub issues](https://img.shields.io/github/issues-closed/arafaysaleem/covid_tracker?color=brightgreen)](https://github.com/arafaysaleem/covid_tracker/issues?q=is%3Aissue+is%3Aclosed) [![GitHub forks](https://img.shields.io/github/forks/arafaysaleem/covid_tracker?color=yellow)](https://github.com/arafaysaleem/covid_tracker/network) [![License: MIT](https://img.shields.io/github/license/arafaysaleem/covid_tracker)](https://github.com/arafaysaleem/covid_tracker/blob/master/LICENSE) [![made-with-python](https://img.shields.io/badge/Made%20With-Flutter-blue)](https://flutter.dev/) +## Table of Contents +INTRODUCTION TO COVID TRACKER +REQUIRED SOFTWARE +INSTALLATION +FEATURES +FUTHER INFORMATION +CONTRIBUTE +TO DO +FEEDBACK +LISCENSE + ## Description -Covid Tracker, an Android app built with **Flutter** framework provides global Covid-19 pandemic information to the public, promoting awarness and safety. +Covid Tracker, an Android app built with **Flutter** framework provides global Covid-19 pandemic information to the public while promoting awarness and safety. API used for data [here](https://corona.lmao.ninja/docs/). **The release apk is available under the release tags. It's also available on this drive link - [Covid Tracker APK](https://drive.google.com/drive/folders/1xazOX_VaaAPzuccusj-hk0zsPZaomDLc?usp=sharing)** @@ -45,9 +56,6 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147 - Maps API to detect nearby danger spots *Feel free to fork and contribute to include these features.* ❤︎ - - ### How to start with Flutter and Dart - ## Further Information From 3f6c22c6660333f018629edaf77a05121143e018 Mon Sep 17 00:00:00 2001 From: Chrystal Williams <141046548+chrystal00@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:14:22 -0400 Subject: [PATCH 09/12] Formatting Changes --- README.md | 43 +++++++++++++++++++------------------------ 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 104542d..478f1f4 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ INTRODUCTION TO COVID TRACKER REQUIRED SOFTWARE INSTALLATION FEATURES -FUTHER INFORMATION -CONTRIBUTE TO DO -FEEDBACK +FURTHER INFORMATION +CONTRIBUTE LISCENSE +CONTACT ## Description Covid Tracker, an Android app built with **Flutter** framework provides global Covid-19 pandemic information to the public while promoting awarness and safety. @@ -37,6 +37,9 @@ Note: Download the versions mentioned above for Flutter and Dart for the code to - Timely news updates on vaccine developements - Detailed information on the virus +Future Features in progress: drawer for easier nagivation, onboarding screens, login authentication using firebase, and maps API to detect nearby danger spots. +*Feel free to fork and contribute to include these features.* + The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147-Coronavirus-Covid-19-Dashboard) (credits to [Nazirul Hoque](https://dribbble.com/nazirulhoque) on Dribble).