README.md
# <img src="app/src/main/ic_launcher-playstore.png" width="30" > Virus Tracker
Software Development Project 2020
> The main goal is to help control the spread by having more insight on it.
> It is made for everyone to use.
> The contamination analysis is mainly based on distance estimation between different users, and meeting occurrences with (potentially) infected users.
> We chose to make the app parametrizable with respect to the actual contamination factor and infection probability, as we can't pretend to know the actual numbers.
>
> NB: this app needs a GPS position to work properly, you won't be able to use it in a bunker!
## App structure
Once you log into the app, you can see 3 different tabs: Map, Status & Account.
### Map
Is a... map containing 5 feature buttons described below.
* Toggle heatmap: show infected areas around you. If you zoom in/out too much, you won't be able to see it anymore. That way, you cannot see the precise location of infected users (privacy friendly). Here's how it looks like:
<p align="center">
<img src="Screenshot_1591386066.png" width="200" >
</p>
* My location: when your fingers got lost on the map, click to see where you are on the map.
* Whole path: to have more insight on which infected areas you've been close too, you are able to see the paths you made yesterday and the day before it. This button allows you to show the whole path on the map, from starting point to ending point. NB: you need to have clicked on a path to show first (see next 2 buttons).
* Yesterday: click here to see your path from yesterday.
* Before yesterday: click here to see your path from the day before yesterday.
<p align="center">
<img src="Screenshot_1591385996.png" width="300" >
</p>
### Status
Concerns the user infection status.
It contains a graph showing your infection probability, and a button to report your infection. You are allowed to change your infection status at most once per day.
<p align="center">
<img src="Screenshot_1591385876.png" width="300" >
</p>
### Account
Contains your user informations. This is where you can sign out and clear your history.
## Note on the contamination detection process
If you take a walk with a sick person or if that person was not known sick and got diagnosed sick the next day, your probability of being sick will increase (not necessarily to 1).
> NB:
> - The transmission of the sickness-probability is proportional to the sickness-probability of the users.
> - If you get cured your probability of infection decreases again, taking into account an immunity factor.
## Little story about the name CoronaGame
> CoronaGame was the initial name for a virus spreading game, supposed to help creating a model for virus spreading. Given the rapid evolution of the current coronavirus situation, we chose to adapt and created Virus Tracker.
## Demo
[Click to see the video!](https://www.youtube.com/watch?v=WAPRaSdV124&feature=youtu.be)
<!--Badges-->
[](https://cirrus-ci.com/github/CoronaTeam/CoronaGame)
[](https://codeclimate.com/github/CoronaTeam/CoronaGame/maintainability)
[](https://codeclimate.com/github/CoronaTeam/CoronaGame/test_coverage)