Skip to content

Commit

Permalink
docs: add FAQ section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
timoknapp committed Mar 19, 2023
1 parent 0783f77 commit 24ccfc5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
</p>
<img width="100%" src="images/demo.jpg">

## Getting Started

[Try it out!](https://timoknapp.github.io/tennis-tournament-finder/)

## Features

* Currently supported tennis federations:
Expand Down Expand Up @@ -39,6 +43,12 @@
* [Tennisverband Schleswig-Holstein (TSH)](https://www.tennis.sh)
* [Westfälischer Tennis-Verband (WTV)](https://www.wtv.de)

## Getting Started
## FAQ

[Try it out!](https://timoknapp.github.io/tennis-tournament-finder/)
### Tournament is not shown with the correct location on the map

This is a known issue. The location of the tournament is not always correct. This is due to the fact that the [OSM](https://www.openstreetmap.de) is not always capable of performing the geocoding right. There are two potential outcomes:

1. Tournament location falls back to the default address of the corresponding tennis federation. There will then be a list of tournaments associated to the default address.
* <img width="20%" src="images/geocoordsNotFound.png">
2. Tournament location is showing a completely different location. In this case please click on the link next to "Adresse". This will then lead you to the address on [Google Maps](http://maps.google.com) and this location is mostly correct.
2 changes: 1 addition & 1 deletion backend/pkg/tournament/tournament.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func GetTournaments(w http.ResponseWriter, r *http.Request) {
util.EnableCors(&w)
Tournaments := []models.Tournament{}

fmt.Printf("Cache consists currenty of: %d geocoordinates.\n", len(openstreetmap.CachedGeocoordinates))
fmt.Printf("Cache consists currently of: %d geocoordinates.\n", len(openstreetmap.CachedGeocoordinates))

today := time.Now()
dateFrom := r.URL.Query().Get("dateFrom")
Expand Down
Binary file added images/geocoordsNotFound.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 24ccfc5

Please sign in to comment.