-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
437804c
commit 4a66449
Showing
1 changed file
with
34 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
# random-restaurant-generator | ||
Android app that queries Yelp's API for a random restaurant near you | ||
# Random Restaurant Generator | ||
|
||
<a href="https://play.google.com/store/apps/details?id=com.chris.randomrestaurantgenerator"> | ||
<img alt="Get it on Google Play" src="http://steverichey.github.io/google-play-badge-svg/img/en_get.svg" /> | ||
</a> | ||
|
||
It uses the [Yelp API](https://www.yelp.com/developers) to query for restaurants and uses the standard Android location API. It also uses [Google Maps Android API](https://developers.google.com/maps/documentation/android-api/) for displaying the location of a restaurant. | ||
|
||
## Description | ||
|
||
Deciding where to eat takes forever. Either your friends / family can never agree on where to go, or you're feeling indecisive and can't pick. With Random Restaurant Generator, you don't have to ask anyone anything or worry about what to pick. Random Restaurant Generator searches for places to eat near you and picks one at random. | ||
|
||
If you don't like the place it finds, swipe it to the left to get a new one. Found one you like? Swipe it to the right to open it in Yelp and check out more info. Got a place that you're thinking about, but not quite sure? Add it to your saved list by clicking the bookmark icon to access it later. | ||
|
||
Features: | ||
- Filter your searches by entering a category or type of food you like (perfect for vegans). | ||
- Ability to use your GPS for places near you or enter a location manually to search a specific area. | ||
- Save restaurants to access them later if you want to narrow down your choices. | ||
- Ability to open the restaurant's page in Yelp for more information. | ||
- Displays a mini Google Maps to show where the restaurant is and to get quick directions to it. | ||
|
||
## Contributing | ||
|
||
Please feel free to submit a pull request if you have any improvements or suggestions. If you run into any issues, please do submit them and give feedback wherever you can. | ||
|
||
## Building | ||
|
||
Building is quite simple with gradle: | ||
|
||
```shell | ||
git clone https://github.com/christarazi/random-restaurant-generator.git | ||
cd random-restaurant-generator/ | ||
./gradlew build | ||
``` |