YumWay

Description

YumWay is a modern food delivery platform designed to bring your favorite meals from local restaurants straight to your doorstep. With a seamless user experience, YumWay allows you to browse menus, place orders, and track deliveries in real-time. Whether you're craving a juicy burger, a cheesy pizza, or a refreshing sushi platter, YumWay connects you with the best restaurants in your area, offering a wide variety of cuisines to satisfy your taste buds.

YumWay is built with a focus on simplicity, speed, and reliability, ensuring that every order is delivered fresh and on time. It’s the ultimate solution for food lovers who want convenience without compromising on quality.

---

Technologies Used

Frontend

• TypeScript: For building a robust and type-safe frontend.
• Tailwind CSS: For creating a responsive and visually appealing user interface.
• React: For building interactive user interfaces.

Backend

• Node.js: For building a scalable and efficient server-side application.
• Express: For creating RESTful APIs to handle requests and manage data.
• TypeScript: For writing clean and maintainable backend code.

Design

• Figma: For designing the UX/UI and creating wireframes and prototypes.

---

UML Diagram

Below is a UML diagrams representing the architecture of YumWay:

---

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• Git
• Vite

Steps

1. Clone the repository:

   git clone [https://github.com/m-elhamlaoui/projet-web-mharek_aitbentaleb/]

2. Navigate to the project directory:

   cd projet-web-mharek_aitnentaleb

3. Install dependencies for both frontend and backend:

    cd frontend && npm install
    cd ../backend && npm install

4. Start the development servers:

• Frontend:

  cd frontend && npm run dev

-Backend:

cd backend && npm  start

5. Access the application: Frontend:

             http://localhost:5173
   

   Backend API:

              http://localhost:3000
              http://localhost:3000/api/restaurants
              http://localhost:3000/api/restaurants/1/
              http://localhost:3000/api/restaurants/1/meals
   

---

Professor Information

Dear Professor,

This project, YumWay, is currently in its initial phase, focusing solely on the food delivery functionality. This includes:

• Browsing restaurants and menus.
• Adding items to a cart.

This is the foundational part of the project, and it serves as a proof of concept for how the full platform will operate. My goal is to demonstrate the core functionality and user experience for the food delivery aspect, which is the heart of the application.

For the frontend, I used Vite as the build tool, which provides a fast and modern development experience. The command npm run dev starts the Vite development server

Future Plans

I intend to expand this project significantly by adding more features and modules, such as:

• User Authentication: Login, signup, and profile management.
• Payment Integration: Secure payment gateways for seamless transactions.
• Admin Panel: A dashboard for restaurants and administrators to manage orders, menus, and users.
• Advanced Features: Real-time notifications, reviews and ratings, and personalized recommendations.

This current version is just the starting point (démarche) of the project, and I am committed to continuing its development to create a fully functional and comprehensive platform.

---

Group Information

Team Members

1. MHAREK Yasmine
   • Email:

     yasminemharek11@gmail.com

2. AITBENTALEB Yassmine