SWE Restaurant Finder

Team Members: Andy Quintuna, Benjamin Shim, Bridget Kegelman, Carolina Martin

Project Description

This project aims to create a user-friendly API that allows restaurant owners to submit their restaurants and menu items and users to discover submitted restaurants in their vicinity. Key features will include user registration/authentication, location-based restaurant discovery, detailed restaurant listings, customer reviews and ratings, search/filters, and issue reporting.

Building Production/New Environments

To build production, type make prod.

To create the env for a new developer, run make dev_env.

Progress and Goals

To see our progress and goals, click here

React App

React front-end repo, click here

Planned Endpoints

• User Registration and Authentication

• User registration.

• User login for personalized restaurant recommendations.

• Location-Based Services

• Allow manual input of location details.

• Find nearby restaurants based on the user's location.

• Restaurant Listings

• List restaurants in the area.

• Get details about a specific restaurant.

• Restaurant Reviews and Ratings

• Get reviews and ratings for a specific restaurant.

• Submit user reviews for restaurants.

• Reporting Issues

• Report issues or problems related to specific restaurants.

• Search and Filters

• Search for restaurants by name, cuisine, or other criteria.

• Apply filters (e.g., cuisine type, price range) to refine restaurant search results.

• User Profile

• View and update user profiles.

• Bookmark and Favorites

• Bookmark favorite restaurants for later reference.

• Be notified if any changes were made to the menu of operating hours of the restaurant.

• Reservations

• View, modify, or create existing reservations.

• Restaurant Owners

• Restaurant owners can manage their restaurant information and menu.

• [] Follow Other Users

• Follow other users and see what they recomend or recomend resturants to them.

CRUD Operations

Create

• user accounts
• bookmarks
• new issue reports
• new reservations

Read

• restaurant listings
• reviews
• user profiles
• and bookmarks
• reservations
• other users

Update

• user profiles
• user location
• updating reservations
• users to follow

Delete

• deleting accounts
• bookmarks
• issue reports
• deleting reservations
• users to follow

Endpoint Completion Priority:

• User Registration and Authentication
• User Profile
• Restaurant Listings
• Location-Based Services
• Restaurant Owners
• Search and Filters
• Bookmark and Favorites
• Reservations
• Restaurant Reviews and Ratings
• Reporting Issues
• Follow other users