Welcome to Foodly, a web application that allows students of our college to conveniently order food from nearby restaurants. This README provides instructions on setting up and running the app locally.
Make sure you have the following installed on your machine:
-
Open two terminals, one for site and the other for server.
-
In the first terminal (site), run the following command to install dependencies:
npm install
-
In the second terminal (./server), run the following command to install server dependencies:
cd server npm install -
After installing dependencies, in the first terminal (root directory), run the following command to start the development server:
npm run dev
-
In the second terminal (
./serverdirectory), run the following command to start the server:npm run start
-
Open your web browser and navigate to http://localhost:3000 to see the result.
-
Email:
-
Password:
- 12345
-
User Authentication:
- Register and log in to your account.
- View and update your profile.
-
Cart and Checkout:
- Allow students to review their selected items in the cart.
- Implement a checkout process for placing orders.
-
Browse Restaurants:
- Explore a list of nearby restaurants.
- View restaurant details, including their menu.
-
Restaurant Authentication:
- Log in to your restaurant account.
- Update restaurant information.
-
Menu Management:
- Add, update, or remove items from the restaurant menu.
-
Enhanced Restaurant Order Management:
- Provide a comprehensive view of order details for restaurants.
- Allow restaurants to update order status to reflect progress (e.g., pending, on the way).
- Profile Pages for Users and Restaurants:
- Dedicated profile pages for both students and restaurant owners.
- Capability to view personal details and update passwords, enhancing account security and customization.
- Restaurant Verification:
- Provide the admin with a list of registered restaurants awaiting verification.
- Implement functionality for the admin to approve or reject restaurant registrations based on predefined criteria.
As Foodly is currently in the prototype stage, some features are yet to be implemented. We plan to enhance the app with the following features in future updates:
-
Secure Transactions:
- Implement a secure payment gateway to facilitate transactions between users and restaurants.
- Ensure compliance with industry standards for payment security to protect user data and financial information.
-
Order Management:
- Develop order tracking and management capabilities to enable users to monitor the status of their transactions.
- Implement features for refunds, order history, and receipts to enhance transparency and accountability.
-
Convenience and Accessibility:
- Enable users to log in to Foodly using their existing Google accounts, streamlining the authentication process.
- Reduce friction during the sign-up/login process by offering a familiar and convenient login option.
- Name: Vardan Rastogi
- Enrollment Number: 22UME119
- Name: Pawan Kumar
- Enrollment Number: 22UEE187
- Name: Vasu Sharma
- Enrollment Number: 22UPE087
If you have any questions or suggestions, feel free to open an issue or contact me.