Skip to content

Commit 3399606

Browse files
committed
Add usage information
1 parent 82f2b53 commit 3399606

9 files changed

Lines changed: 51 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@ Times of interest
77
![LINES OF CODE](https://img.shields.io/tokei/lines/github/Questionable-Research-Labs/Govhack-2021?style=for-the-badge)
88
![LICENSE](https://img.shields.io/github/license/Questionable-Research-Labs/Govhack-2021?style=for-the-badge)
99

10-
A web app designed to allow everyone easy and user-friendly access to a map of COVID-19
11-
locations of interest.
10+
Toi (pronounced "toy") is a tool that lets you visualize the all the COVID-19 locations of interest and outlined by the New Zealand Ministry of Health, and allows you to filter by name and by time.
11+
12+
## Features
13+
- Filtering by date, so you can see if you were in an area of interest during any given period of time
14+
- Search for location by name
15+
- Push notification for when new locations are added
16+
- Insatiable PWA with offline support
17+
- Intuitive map interface
18+
19+
For a walk though visit [walkthrough.md](walkthrough.md)
1220

1321
## Toi Backend code
1422
Available at [Questionable-Research-Labs/Govhack2021-backend](https://github.com/Questionable-Research-Labs/Govhack2021-backend)

screenshots/bell-icon.png

2.03 KB
Loading

screenshots/date-filter.png

8.28 KB
Loading

screenshots/date-results.png

9.74 KB
Loading

screenshots/location-filtering.png

4.88 KB
Loading

screenshots/map-screen.png

242 KB
Loading

screenshots/notification-popup.png

47.8 KB
Loading

screenshots/welcome.png

124 KB
Loading

walkthorugh.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Usage
2+
## Welcome screen
3+
When you first open the app, you will be brought to the welcome screen
4+
5+
![Welcome screen](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/welcome.png)
6+
7+
To view the application click on `View the map`
8+
9+
*Note*: This screen will be skipped if you have installed as a PWA
10+
11+
## The map
12+
The meat of and potatoes of the application happens here
13+
14+
![Map Screen](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/welcome.png)
15+
16+
This is the view of the map with all of the COVID-19 locations of interest.
17+
18+
### Date filtering
19+
You can filter the locations by using the slider at the bottom
20+
![Date filter](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/welcome.png)
21+
22+
Drag the point change the date range, the filter range will be reflected in the header
23+
24+
![Date filter results](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/date-results.png)
25+
26+
### Name filtering
27+
28+
Enter the name of the location to filter results in the Address/Location field
29+
30+
![Date filter results](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/date-results.png)
31+
32+
### Push notification
33+
34+
Push notifications for new COVID-19 Locations of Interest can be enable or disabled by pressing the bell button.
35+
36+
![Bell Icon](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/bell-icon.png)
37+
38+
39+
Enable or disable notifications with the button
40+
41+
![Bell Icon](https://raw.githubusercontent.com/questionable-research-labs/govhack-2021/main/screenshots/notification-popup.png)

0 commit comments

Comments
 (0)