Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 3.16 KB

README.md

File metadata and controls

72 lines (56 loc) · 3.16 KB

Menu Creation Application

image

Overview

The Menu Creation Application is a React-based web app that allows managers to generate weekly menus from a predetermined recipe database. Managers can filter recipes based on employee allergies, toggle days off, and export the generated menu as a PDF.

Features

Menu Generation: Managers may click the "Generate Menu" button to create a weekly menu for a default of 90 days. A manager may instead select a start and end date to create a menu with a specific timeframe. Scheduled meals are saved in local storage and will be cleared if allergy information changes.

Allergy Preferences: Managers may use the pop-out module to exclude dishes containing selected employee allergens.

Day Toggle: Using a slider, managers may mark days off to prevent menu generation for those days. Calendar days that are marked as days off will have a solid background for easy visibility.

PDF Export: Print or save the generated menu as a PDF. Menu information such as dates, dish names, ingredients, and days off are organized in chronological order in list format.

Responsiveness: Our app is easy to navigate and is viewable on desktop, tablet, and mobile.

Tech Stack

  • React – Front-end framework
  • JavaScript – Primary programming language
  • HTML – Markup language for structure
  • CSS - Vanilla CSS styling
  • LocalStorageDB - Database framework

Installation

To run the application locally:

  1. Clone the repository: 
    git clone https://github.com/chingu-voyages/V53-tier2-team-27.git
  2. Navigate to the project directory: 
    cd menu-scheduler
  3. Install dependencies: 
    npm install
  4. Start the development server: 
    npm run dev
  5. Open your browser and go to http://localhost:3000.

Usage

  1. Open the application.
  2. Click the "Generate" button to create a menu.
  3. (Optional) Open the allergy filter module and select allergens to exclude dishes.
  4. Toggle days off as needed.
  5. Click "Print PDF" to export the menu.

Deployed

https://considerate-carrot.netlify.app/

Our Team