User Guide

• 1. Introduction
• 2. Quick Start
• 3. Features
  • 3.1. Add: add
  • 3.2. Delete: delete
  • 3.3. List: list
  • 3.4. Search: search
  • 3.5. Sales: sales
  • 3.6. Clear: clear
  • 3.7. Saving: bye
  • 3.8. Loading
• 4. Command Summary

Introduction

Restaurant Daily Report is a CLI app that generates a whitepaper, summarizing the internals of a restaurant. It’s aim is to provide restaurant owners a quick overview of how their restaurant is performing daily so that restaurant owners can better manage their business operations.

As such, the daily report will include these categories:

• Menu: Information on all menu items
• Reservation: Information on number of reservations a day
• Stock: Information on all food items/quantities/prices

Quick Start

1. Ensure that you have Java 11 or above installed.
2. Download the latest version of Restaurant Daily Report from here.

Features

Add menu items, ingredients and reservations.

* words in UPPERCASE: parameters
* parameters in [ ]: optional parameters
* parameters in { | }: at least one of them
* sequence of the parameters can be changed

Add

Add menu items, ingredients, and reservations.

Add menu item: add dish

• Format: add dish; n/NAME; [i/INGREDIENT1, INGREDIENT2, ...]; p/PRICE;
  • Example: add dish; n/bacon pizza; i/cheese, bacon; p/7.00;
    
  • Expected:

• Expected error message if wrong format:

Add ingredient into stock: add stock

• Format: add stock; i/INGREDIENT1; q/QUANTITY; p/PRICE;
  • Example: add stock; i/tomato; q/10; p/0.50;
    
  • Expected:

• Expected error message if wrong format:

Add reservation into list: add reservation

• Format: add reservation; p/CONTACT_PERSON_NAME; d/DATE; n/NUMBER_OF_GUESTS; c/CONTACT; [m/COMMENTS];
  
  • Example: add reservation; p/Peter; d/2020-03-12 12:00; n/3; c/98955555;
    
  • Expected:

• Expected error message if wrong format:

The DATE must be in yyyy-mm-dd HH:mm format. The NUMBER_OF_GUESTS must be a non-negative integer.

Delete

Delete menu items, ingredients and reservations.

Delete menu item: delete dish

• Format: delete dish; n/NAME;
  • Example: delete dish; n/bacon pizza;
    
  • Expected:

• Expected error message if wrong format:

Delete ingredient in stock: delete stock

• Format: delete stock; i/INGREDIENT; [q/QUANTITY;]
  • Example: delete stock; i/tomato; q/1;
    
  • Example: delete stock; i/tomato;
    
  • Expected:

• Expected error message if wrong format:

Mark reservation as invalid: delete reservation

• Format: delete reservation; r/NUMBER_OF_RESERVATION;
  
  • Example: delete reservation; r/1;
    
  • Expected:

• Expected error message if wrong format:

Mark reservation as served: mark reservation

Cannot mark the reservation as served if the reservation is originally invalid.

• Format: mark reservation; r/NUMBER_OF_RESERVATION;
  
  • Example: mark reservation; r/4;
    

• Expected error message if wrong format:

List

List items in the menu, stock and reservations.

• List menu : list dish;
  • Expected:

• Expected error message if wrong format:

• List stock : list stock;

  • Expected:

• Expected error message if wrong format:

• List all reservation : list reservation;
  • Expected:

• Expected error message if wrong format:

• List served reservation : list served reservation;
  • Expected:

• Expected error message if wrong format:

• List unserved reservation : list unserved reservation;
  • Expected:

• Expected error message if wrong format:

Search

Search items in the menu, stock and reservations.

Search for dish: search dish

• Search dish : search dish; k/KEYWORD;
  • Example: search dish; k/bacon;
  • Expected:

• Expected error message if wrong format:

Search for stock: search stock

• Search stock : search stock; k/KEYWORD;
  • Example: search stock; k/tomato;
  • Expected:

• Expected error message if wrong format:

Search for reservation: search reservation

• Search reservation : search reservation; {r/RESERVATION_NUMBER; | d/DATE;}
  
  • Example: search reservation; r/1;
    
  • Example: search reservation; d/2020-03-12;
    

  • Example: search reservation; r/0; d/2020-02-02;
    

  • Expected:

• Expected error message if wrong format:

The DATE must be in yyyy-mm-dd format. The RESERVATION_NUMBER must be a non-negative integer.

Sales

Add daily sales and calculate profit

Sell item : sell item

• Format: sell dish; d/DISH; q/QUANTITY;
• Example: sell dish; d/bacon pizza; q/10;
  • Expected:

• Expected error message if wrong format:

Generate Profit : calculate profit

Calculates the net profit from all the sold dishes. DO ENSURE that the ingredients in the dishes ARE ALSO in the stock as well.

• Format: profit
  • Expected:

• Expected error message if wrong format:

Find most popular dish : popular

Prints the most popular dish from the sold list.

• Format: popular
  • Expected:

• Expected error message if wrong format:

Clear

Clear the stock or reservation list.

Clear stock : clear stock

• Format clear stock;
  • Expected:

• Expected error message if wrong format:

Clear reservation : clear reservation

• Format: clear reservation;
  • Expected:

• Expected error message if wrong format:

Saving

All dishes, stock and reservations will be saved to report.txt automatically after the program is exited.

Exit Program: bye

• Format: bye

Loading

Dishes, stock and reservations will be automatically loaded when the program is started.

Command Summary

Add

• Format: add dish; n/NAME; [i/INGREDIENT1, INGREDIENT2, ...]; p/PRICE;
• Format: add stock; i/INGREDIENT1; q/QUANTITY; p/PRICE;
• Format: add reservation; r/NUMBER_OF_RESERVATIONS;

Delete

• Format: delete dish; n/NAME;
• Format: delete stock; i/INGREDIENT; q/QUANTITY;
• Format: delete stock; i/INGREDIENT;
• Format: delete reservation; r/NUMBER_OF_RESERVATIONS;

Mark

• Format: mark reservation; r/NUMBER_OF_RESERVATIONS;

List

• Format: list dish;
• Format: list stock;
• Format: list reservation;
• Format: list served reservation;
• Format: list unserved reservation;

Search

• Format: search dish; k/KEYWORD;
• Format: search stock; k/KEYWORD;
• Format: search reservation; {r/RESERVATION_NUMBER; | d/DATE;}

Sales

• Format: sell dish; d/DISH; q/QUANTITY;
• Format: profit
• Format: popular

Clear

• Format: clear stock;
• Format: clear reservation;