Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 6.25 KB

README.md

File metadata and controls

75 lines (51 loc) · 6.25 KB
Raw

YumRun Food Ordering App

Welcome to **YumRun**! This is a food ordering app designed to make your dining experience quick and easy. Built with React and styled with Tailwind CSS, YumRun offers a sleek and user-friendly interface for placing food orders.

Table of Contents

About

YumRun is a project created to practice and enhance skills while learning from Akshay Saini's React course.

It aims to provide a smooth and enjoyable experience for users looking to order food quickly and efficiently. The app is built using React for the front end and Parcel for bundling and development.

Key Features

  • Explore Menus🍽️: Discover an extensive selection of menus from different restaurants, complete with detailed descriptions and mouth-watering images.
  • Dynamic Cart Management🛒: Add, remove, and modify items in your cart with ease. The cart dynamically updates as you make changes, ensuring you have full control over your order before checkout.
  • Smooth Navigation🔄: Navigate effortlessly between the menu, cart, and checkout pages with a user-friendly interface that prioritizes ease of use.
  • Responsive Design📱💻: Enjoy a consistent experience across all devices, with a design that adapts perfectly to any screen size.
  • Shimmer UI for Seamless Loading✨: Experience smooth transitions with Shimmer UI, providing visual feedback while content loads, ensuring users are engaged even during data fetches.
  • Customizable Themes🌞🌙: Switch between light and dark modes with an animated toggle button, enhancing usability in different lighting environments.
  • Infinite Scrolling⏳: Browse through endless options without interruptions, thanks to the infinite scrolling feature that loads new content as you scroll.

Technologies Used

  • React⚛️: A JavaScript library for building user interfaces.
  • React Router DOM🛤️: A standard library for routing in React applications.
  • Redux🔄: A predictable state container for JavaScript apps, useful for managing application state.
  • Tailwind CSS🎨: A utility-first CSS framework for styling.
  • Parcel📦: A fast, zero-configuration web application bundler.
  • Swiggy API🍲: Used for fetching backend data related to restaurant menus and orders.

Getting Started

To get started with YumRun, follow these steps:

  1. Clone the Repository

    git clone https://github.com/sankitdev/YumRun.git

  2. Navigate to the Project Directory

    cd yumrun

  3. Install Dependencies

npm install
  1. Start the Development Server
  npm start

Contributing

  • If you'd like to contribute to YumRun, feel free to submit a pull request or open an issue. Contributions are welcome and appreciated!

License

This project is licensed under the MIT License. See the LICENSE file for details.