Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.75 KB

README.md

File metadata and controls

82 lines (49 loc) · 3.75 KB

Foody Tweet

Foody is an android application which helps you to find restaurants near to your location or anywhere else for free.

Getting Started

Foody suggest you nearby restaurants based on your location and cuisine preferences. You can get the location details of each restaurant, it’s rating, average cost for two people, total number of votes, popularity, top cuisines and much more.

You can mark some restaurants favourite, which will be shown in home screen widget and also share the details of any restaurant. It helps the users to find a way to any restaurant from their current location by directing them to google maps.

Prerequisites

You need to have basic knowledge of android development to understand this project. Exposure of external libraries used in the android application is a plus. If you want to download the code in your local system, you can do it by the executing the below command or downloading the code directly as a zip file.

git clone https://github.com/rahulmalhotra/Foody.git

Installing

You need to add your own gradle.properties file as the api keys are defined there. There are mainly 3 apis used:-

  1. Zomato API
  2. Google Places API
  3. Admob API

All the api keys are used in the defaultConfig section of build.gradle file. In the app manifest also, the api keys are used from gradle.properties file.

In your newly created gradle.properties file, you can add your api keys in the form of key value pairs. For ex :-

GOOGLE_API_KEY=abcd123123123abcd

Foody is now ready for use.

Deployment

You can deploy Foody android application directly to your device by installing the apk file. You can run the code in android studio and create an apk yourself or use the apk present in this repository. You can find the apk file here.

Application Screenshots

NearBy Restaurants Screen

Nearby

Favorite Restaurants Screen

Favorites

Restaurant Detail Screen

Restaurant Detail

Change Location Screen

Change Location

Cuisine Preferences Screen

Cuisine Preferences

Settings Screen

Settings

Tools and Softwares used

I used only android studio to build this application. You can download android studio for your system using the below link :-

Capstone Stage 1 Document

You can find the design document related to this application in this repository here. It consists of the whole design and other information used to build this application.

Contributing

Please read CONTRIBUTING.md for details on code of conduct and the process for submitting pull requests.

Authors

License

This project is licensed under the BSD 3-Clause License - see the LICENSE.md file for details.