Skip to content
/ Fickle Public

A React Native application that picks your dinner for you using Yelp API

License

Notifications You must be signed in to change notification settings

shonore/Fickle

Repository files navigation

Certainly! Here's an example of a README.md file for the "# Fickle" React Native application:

Fickle

Fickle is a React Native application that picks your dinner for you using the Yelp API. It helps you overcome the struggle of deciding where to eat by providing a random restaurant recommendation based on your preferences.

Features

  • Random Restaurant Picker: Fickle uses the Yelp API to fetch a list of restaurants based on your location and preferences. It then randomly selects one of the restaurants for you to try, taking the burden of decision-making off your shoulders.

  • Preferences and Filters: Fickle allows you to set your preferences and apply filters to narrow down the restaurant selection. You can specify your desired cuisine, price range, distance, and more, ensuring that the recommendations align with your preferences.

  • Restaurant Details: Once Fickle picks a restaurant for you, it provides detailed information about the chosen establishment, including ratings, reviews, contact information, and directions. This enables you to learn more about the restaurant before making a decision.

Installation

  1. Clone the repository: git clone https://github.com/your-username/fickle.git
  2. Navigate to the project directory: cd fickle
  3. Install the dependencies: npm install
  4. Configure the Yelp API credentials by adding your API key in the designated file.
  5. Run the application on a simulator or device: npx react-native run-ios or npx react-native run-android

Note: You may need to have the necessary development environment set up for React Native to run the application on your desired platform.

Contributing

Contributions to Fickle are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository. If you would like to contribute code, feel free to fork the repository and submit a pull request with your changes.

Before contributing, please review the contribution guidelines for more details.

License

Fickle is open-source software licensed under the MIT license.

Acknowledgements

Fickle makes use of the Yelp API to provide restaurant data. We would like to express our gratitude to Yelp for its API and services.

Contact

For any inquiries or questions, please contact the project maintainers:

We look forward to hearing from you!


About

A React Native application that picks your dinner for you using Yelp API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published