Skip to content

chingu-voyages/v50-tier2-team-16

Repository files navigation

YumSpot

YumSpot Logo

Overview

Yumspot is a front-end web application for ordering food from restaurants around the United States. Simply filter your desired search by location or foodtype, and all relevant participating restaurant menus populate for you to choose from.

Features

User access: A guest visiting the website has the ability to register an account. Once registered, the user may add funds to their account and purchase products. User information is stored in localStorage and can reaccessed after logging out and back in.

Account balance: A signed-in user may add funds to their account. This feature is used for ordering products. A user cannot purchase from the menu without an adequate balance. When a purchase is made, the balance updates automatically.

Filter functionality: Filter through the results by your location (city and/or state) and preferred foodtype. If your chosen city is not available in the chosen state, the filter will include results for that city in other states. The foodtype filter can be applied independent of the location filter and vice versa, in the case you would like to just apply one filter.

Interactive map: Search restaurants in your city or a city near you to find a destination to eat. The map will display restaurant locations with information like restaurant name, description, rating, and an image. The user has the ability to zoom in and out and has the range to search all over the United States.

Order section: When the user has chosen to buy from the menu, they can add to their order. The item is moved into a pop-out sidebar that displays a virtual cart. Items can be added and removed from the cart, the quantities can be modified, and the user has the ability to make a purchase. At checkout, the user may add a tip. If the user has enough funds in their account, the purchase will be successful.

Running the project

  1. Clone this project locally
  2. cd into the project directory
  3. To run the app on your local device, make sure to install the appropriate packages and run using the following command:
    npm install 
    npm run dev
  4. Search for the most Yumspot in your area!

Dependencies

React
Tailwind

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Our Team

Deployed sites:

https://yumspot.netlify.app
https://yumspotdev.netlify.app