Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editing Covid_Tracker README File #19

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

![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, 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

Expand All @@ -26,7 +27,7 @@ The UI is inspired by a design on [Dribbble](https://dribbble.com/shots/10847147
</div>


## Future Features
## Future Features

- Drawer for easier navigation
- Onboarding screens
Expand All @@ -35,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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to keep the logos

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just for a school assignment where I make suggestions to a README file so you can take me suggestions with a grain of salt.

## 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.
Expand All @@ -49,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:

Expand All @@ -61,19 +62,19 @@ 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)
3. Insert comments into code for future contributors
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.

Expand Down
Loading