Description of Project

Willeats is an online ordering platform that makes ordering easier both for the business owners and customers. For each dish on the menu, users can first see the reviews and write a review after their order. Restaurants can create and modify their menu and reply to the customers’ reviews.

Instructions for Business Owners

To enable users to access your restaurant, please follow these steps:

1. Log in to your account on the platform.

2. Locate the button labeled "See Your Restaurant URL" and click on it.

3. You will now be able to view your unique restaurant ID. Append this ID to the following URL: https://orca-app-p3any.ondigitalocean.app. This will create a unique URL for your restaurant's page.

4. If you'd like to make it even more convenient for your customers, you can convert this URL into a QR code using any online URL-to-QR code generator of your choice. This will allow your customers to access your restaurant's page and place orders simply by scanning the QR code.

By following these instructions, you'll create an accessible and user-friendly way for your customers to order from your restaurant through the platform!

Product Vision Statement

The Minimum Viable Product will include:

Theme: Business owners

1. Users will be able to add/delete the dishes from the menu
2. Users will be able to upload images for the dishes.
3. Users will be able to change the price and orders of the dishes.
4. Users will be able to view and reply to customers’ reviews.
5. Users will be given an Id to generate a QR code for the business.

Theme : Customers

1. Users will be able to view the menu.
2. Users will be able to add dishes to the cart.
3. Users will be able to add reviews to the dish they ordered
4. Users will be able to view the reviews per dishes written by other customers
5. Users will be able to access the restaurant menu through scanning the QR code

Core Team Members

Jiahong Jiang - jhjoseph2
Will Chen - Willcky
Alicia Hwang - a-j-hwang
Junrui Li - HYS20010113

History of Project

In reality, it is always hard for the customers to visualize the dishes from plain texts on the menu. So every time they order is like making a guess. Besides, during the time with high-volume, customers often find it hard to find a waiter for them to order or pay the check. To address these problems, the restaurant owners must hire more waiters and make the menu longer traditionally. We initialize WillEats to address such problems.

Contributions

Please refer to the CONTRIBUTING.md for more information.

Instructions for Building and Testing the Project

Clone the source code from Github

1. Run git clone https://github.com/agiledev-students-spring-2023/final-project-willeats to create a local repository in any folder you like
2. Install Node.js if you don’t have it
3. Open the cloned folder in VS Code

Deploy the backend server

1. Navigate into back-end directory (use cd back-end)
2. Run npm install and npm start to develop and deploy the back end server

Deploy the front end

1. Navigate into the front-end directory (use cd ../ to back to main folder (if still in the back-end folder)and use cd front-end)
2. Run npm install and npm start to develop and deploy the front end

Additional Resources

Prototype Design

Initial Proposal