Skip to content

Latest commit

 

History

History
97 lines (54 loc) · 3.05 KB

README.md

File metadata and controls

97 lines (54 loc) · 3.05 KB
Raw

Restaurant Digital Menu App with React and WordPress

A modern and user-friendly digital menu application built using React and WordPress. This app allows restaurants to showcase their menus digitally, providing customers with an engaging and interactive way to explore the available dishes. The app leverages the WordPress REST API to fetch menu items and categories, creating a seamless and efficient solution for restaurant owners.

Features

  • Digital Menu Display: Present your restaurant's menu in an attractive and intuitive format similar to popular food ordering apps.

  • Custom Post Types: Create custom post types in WordPress for each location, allowing you to manage menu items, categories, images, titles, descriptions, and prices with ease.

  • WordPress REST API Integration: Fetch menu data directly from your WordPress backend using the WordPress REST API, ensuring real-time updates and consistency.

  • User-Friendly UI: The app's user interface is designed for a seamless and enjoyable browsing experience for customers.

Getting Started

Follow these steps to get the Restaurant Digital Menu App up and running on your local development environment using Yarn:

  1. Clone the Repository:

    bashCopy code

    git clone https://github.com/your-username/restaurant-menu-app.git

  2. Navigate to the Project Directory:

    bashCopy code

    cd restaurant-menu-app

  3. Install Dependencies:

    bashCopy code

    yarn install

  4. Configure WordPress Backend:

    • Set up a WordPress site for your restaurant and create custom post types for each location with menu items, categories, images, titles, descriptions, and prices.
    • Make sure the WordPress REST API is enabled and accessible.

  5. Update API Endpoint:

    Open the src/config.js file and replace the API endpoint with your WordPress REST API URL.

  6. Start the Development Server:

    bashCopy code

    yarn start

  7. Access the App:

    Open your web browser and visit http://localhost:3000 to view the Restaurant Digital Menu App.

Usage

  1. Browse through the menu categories and items.
  2. Click on a menu item to view its details, including title, description, and price.
  3. Enjoy an interactive and visually appealing way to showcase your restaurant's offerings to customers.

Contributing

We welcome contributions from the community! If you'd like to enhance the Restaurant Digital Menu App, please follow these guidelines:

  1. Fork the repository.

  2. Create a new branch for your feature or bug fix:

    bashCopy code

    git checkout -b feature-name

  3. Make your changes and commit them:

    bashCopy code

    git commit -m "Add your feature or fix"

  4. Push your changes to your fork:

    bashCopy code

    git push origin feature-name

  5. Create a pull request on the main repository, explaining your changes and their benefits.

  6. We'll review your pull request and provide feedback before merging.

License

This project is licensed under the [MIT License]