View on GitHub

tp

User Guide

Table of content

1. Introduction

2. Quick start

3. Features

3.1 Before the order

3.2 Begin the order

3.2.1 Firstly
3.2.2 The order method will be activated and print open stalls, user just type the corresponding index before the canteen to select canteen
3.2.3 Then the open stalls in this canteen will be printed, user just type the corresponding index before the stall to select stall
3.2.4 Then the available dishes and price in this stall will be printed, user just type number of dishes he wants to order
3.2.5 User chooses dishes in the same way as they select canteen and stall
3.2.6 User will be asked whether he wants to see the comment of the dish, just type y/n
3.2.7 User choose the order type by typing the corresponding index before the type

3.3 delete the specific order

3.4 find the specific order

3.5 list all the orders

3.6 change the order

3.7 check Canteen Operating Time

3.7.1 Firstly
3.7.2 User enters the number before canteen to check that specific canteen

3.8 ccheck Stall Operating Time

3.8.1 Firstly
3.8.2 User enters the number before canteen to check that specific canteen
3.8.3 User enters the number before stall to check that specific stall

3.9 view all available commands

3.10 quit the system

4. Command Summary

1. Introduction

During peak hours, people may not be able to know the dining situation and the density of the canteen they want to go to. To solve this problem, we want to create a program to store and display basic information of stalls in each canteen (e.g. Open hours, current menu, change order etc) to all their potential users. CanteenHelper is a command line (CLI) application that helps students, staff and even tourists order food in canteens efficiently. CanteenHelper will allow users to choose their favorite dishes from different stalls in different canteens based on the date and time provided by the users. They also can check the comments of the dishes and operating hours of the stalls and canteens.

2. Quick Start

  1. Ensure that you have Java 11 or above installed.
  2. Down the latest version of CanteenHelper from here.

3. Features

3.1 Before the order:

[name]/[day of week]/[time]

Format: [name]/[day of week]/[time]

Example of usage: ‘wy/2/1800’ ‘fqy/1/1200

Result is like this:

image

3.2 Begin the order:

order begin the order of a customer

3.2.1 Firstly

Format: order

Example of usage: ‘order’

Result is like this:

image

3.2.2 The order method will be activated and print open stalls, user just type the corresponding index before the canteen to select canteen.

Format: [number]

Example of usage: ‘2’

Result is like this:

image

3.2.3 Then the open stalls in this canteen will be printed, user just type the corresponding index before the stall to select stall.

Format: [number]

Example of usage: ‘1’

Result is like this:

image

3.2.4 Then the available dishes and price in this stall will be printed, user just type number of dishes he wants to order.

Format: [number]

Example of usage: ‘2’

Result is like this:

image

3.2.5 User chooses dishes in the same way as they select canteen and stall.

Format: [number]

Example of usage: ‘2’

Result is like this:

image

3.2.6 User will be asked whether he wants to see the comment of the dish, just type y/n.

Format: y/n

Example of usage: ‘y’, ‘n’

Result is like this:

image

3.2.7 User choose the order type by typing the corresponding index before the type.

Format: [number]

Example of usage: ‘2’

Result is like this:

image

3.3 delete the specific order:

delete [number] delete the order based on the number from user user needs to input the number of order

Format: delete [number]

Example of usage: ‘delete 1’

Result is like this:

image

3.4 find the specific order:

find [dish name] find the specific dish based on the user input dish name from the order list made by the user

Format: find [dish name]

Example of usage: ‘find Hawaiian’

Result is like this:

image

3.5 list all the orders:

list check all the orders made by this user

Format: list

Example of usage: ‘list’

Result is like this:

image

3.6 change the order:

change/[number]/[type] Change the order type to the type user inputed

Format: change/[number]/[type]

type should choose from:

  1. dine in
  2. delivery
  3. take away

Example of usage: ‘change/2/dine in’ ‘change/1/delivery

Result is like this:

image

3.7 check Canteen Operating Time:

checkcanteen check the operating hours of a canteen

3.7.1 Firstly

Format: checkcanteen

Example of usage: ‘checkcanteen’

3.7.2 User enters the number before canteen to check that specific canteen

Format: [number]

Example of usage: ‘4’

Result is like this:

image

3.8 check Stall Operating Time:

checkstall check the operating hours of a stall

3.8.1 Firstly

Format: checkstall

Example of usage: ‘checkstall’

3.8.2 User enters the number before canteen to check that specific canteen

Format: [number]

Example of usage: ‘3’

3.8.3 User enters the number before stall to check that specific stall

Format: [number]

Example of usage: ‘2’

Result is like this:

image

3.9 view all available commands:

help print all the commands with required format that the user can input

Format: help

Example of usage: ‘help’

image

3.10 quit the system:

bye quit the system

Format: bye

Example of usage: ‘bye’

Result is like this:

image

4. Command Summary

Action Command Example
order order order
delete delete [number] delete 2
find find [dish name] find Pork Chop
list list list
change change/[number]/[type] change/3/take away
check Canteen Operating Time checkcanteen checkcanteen
check Stall Operating Time checkstall checkstall
help help help