Food-Yelp-App

Find delicious restaurants using Yelp API.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This project is a starter app to help you get started with creating a restaurants app using the Yelp API I started this project to practice developing. By no means is this project polished or finished. Feel free to build upon it.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• React-Native
• Expo
• Axios

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

There are a few thing you will need.

• npm

npm install npm@latest -g

Installation

1. Get a free API Key at https://www.yelp.com/developers/v3/manage_app
2. Clone the repo

git clone https://github.com/tayek333/Food-Yelp-App

3. Install NPM packages

• Axios

npm install axios

• React Navigation

npm install @react-navigation/native

expo install react-native-gesture-handler react-native-reanimated react-native-screens react-native-safe-area-context @react-native-community/masked-view

npm install @react-navigation/stack

4. Enter your API in yelp.js

Authorization: 'Bearer [YOUR API KEY HERE]'

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tarek Bukhari - @tarek_bukhari - tarekbukhari123@gmail.com

Project Link: https://github.com/tayek333/Food-Yelp-App

Acknowledgements

• React Navigation
• Axios
• Expo Vector Icons