CupQuest is a mobile-based application that serves as a comprehensive guide for coffee lovers. It functions as a platform exclusively for coffee shops, allowing users to search for coffee shops in their area, read reviews, and connect with friends. The app combines data from the Google Maps API and the Yelp API to provide accurate and up-to-date information about coffee shops.
- User Account and Authentication: CupQuest provides users with the ability to create their own accounts. The app utilizes Google Authentication to ensure secure and easy login for users. User information is stored in Firebase, ensuring data security.
- Coffee Shop Search: With the help of the Google Maps API and the Yelp API, CupQuest offers a powerful search feature that allows users to find coffee shops in their vicinity. User searches are based on location, though results can be filtered by drinks and ratings.
- Coffee Shop Information: Once a coffee shop is selected, CupQuest gathers detailed information from Yelp, including hours, contact information, and photos. The menu is standardized across all coffee shops with basic drinks available anywhere, but there is an option for Specialty drinks to submit reviews for more creative beverages. These menu items are displayed with their average rating from the submitted reviews.
- Coffee Shop Reviews: When a coffee shop is selected, users can read reviews left by other users--their friends showing first. Users can react by liking or disliking individual reviews. Users can also submit their own reviews by drink using the review submission form above the list.
- Friends and Chat: CupQuest allows for connecting with friends and fellow coffee enthusiasts. Users can add and remove friends, see other users' review history, and message with friends. This feature encourages a sense of community and fosters engagement among users.
To get started with CupQuest, follow these steps:
- Navigate to [CUPQUEST DEPLOYED URL].
- Make a new account, log into your existing account, or sign in with Google.
- Grant the necessary location permissions to ensure accurate search results.
- Explore the various features of searching for coffee shops, reading reviews, and connecting with friends.
- Customize your profile, change your profile picture, and update your preferences.
To continue development for CupQuest, follow these steps:
- Fork the CupQuest repository from GitHub.
- Create a new branch for your contribution.
- Install dependencies using NPM package manager:
npm install
- Create a .env file with the following keys, sourced from the the listed places:
- Google Maps Dev
VITE_MAP_API_KEY=<key>
- Yelp Dev
VITE_YELP_API_KEY=<key>
VITE_YELP_CLIENT_ID=<key>
- Your database
DATABASE=<your MongoDB connection string>
- The port you are running on
PORT=3000
- Firebase
VITE_FIREBASE_API=<key>
VITE_FIREBASE_AUTH_DOMAIN=<domain>
VITE_FIREBASE_PROJECT_ID=<project id>
VITE_FIREBASE_STORAGE_BUCKET=<storage bucket>
VITE_FIREBASE_MESSAGING_SENDER_ID=<messaging sender ID>
VITE_FIREBASE_APP_ID=<app ID>
VITE_FIREBASE_MEASUREMENT=<measurement>
VITE_FIREBASE_STORAGE=<storage>
- Google authentication
VITE_GOOGLE_CLIENT_ID=<client ID>
- Then build the app using the following script. This will run Vite in watch mode, so as you make changes it will recompile upon saving.
npm run build
- Then in a separate terminal window run the following command. This will run the Node.js server with Nodemon, so it restarts upon changes.
npm run server
- Note: You will have to use your own database for development purposes, but should changes be accepted your portion will integrate with the proprietary one.
Data is sourced from two external APIs:
- Google Maps, through the google-maps-react package
- Yelp Fusion endpoints:
- /businesses/search
- /businesses/matches
- /businesses/:id
Next steps for CupQuest will involve:
- Adding comment functionality to reviews
- Specified menu based on actual available items at coffee shops