My Restaurants

A restaurant finder

By Scott McIntire

Description

This Android app allows users to search the Yelp restaurant database for restaurants in a zip code. Users can save their favorites and find information on the restaurants.

Setup/Installation Requirements

You will need these programs to launch the application:

Android Studio
Android SDK

To Run Application

In a terminal window, navigate to ~/AndroidStudioProjects
Run git clone https://github.com/scottmcintire90/myRestaurants-android
Navigate to ~/AndroidStudioProjects/DoeApp
Run on either an emulator or an Android OS Device connected to a computer

To set up an emulator

Select Run > Run 'app'
Click 'Create New Emulator'
Select the device you would like to emulate (Recommended: Nexus 6)
Select the API level you would like to run - click 'Download' if not available
Select configuration settings for emulator
Click 'Finish' and allow Emulator to run

To Run on an Android OS Device

Connect the device to the computer through its USB port
Make sure USB debugging is enabled (this may pop up in a window when you connect the device or it may need to be checked in the phone's settings
Select Run > Run 'app'
Select the device (If it does not show, USB debugging is probably not enabled)
Click 'OK'

Technologies Used

Java, Android Studio, Gradle, Firebase

Legal

This software is licensed under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ScottMcintire90/myRestaurants-android