Skip to content

Latest commit

 

History

History
273 lines (194 loc) · 7.36 KB

UserGuide.adoc

File metadata and controls

273 lines (194 loc) · 7.36 KB

EYELAH - User Guide

By: AY1920S2-CS2103T-W13-1 Since: Mar 2020

1. Introduction

Ease Your Life At Halls (EYLAH) is for those who prefer to use a desktop app to solve issues related to Halls of Residences in National University of Singapore (NUS). More importantly, EYLAH is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, EYLAH can solve your problems in halls by tracking your diet after those unhealthy supper runs and splitting the cost after each outing or late-night party session. Interested? Jump to Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest eylah.jar here.

  3. Copy the file to the folder you want to use as the home folder for your EYLAH application.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

    Ui

  5. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  6. Some example commands you can try:

    • list : lists all contacts

    • add : enters the diet segment of the program.

    • split : enters the expense splitter segment of the program

    • exit : exits the app

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in addperson -n NAME, NAME is a parameter which can be used as addperson -n John Doe.

  • Items in square brackets are optional e.g -n NAME [-r ROOM] can be used as -n John Doe -r D411 or as -n John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [-n NAME]…​ can be used as   (i.e. 0 times), -n John Doe, -n John Doe -n Daniel etc.

3.1. Viewing help : help

To provide help for users
Format: help

3.2. Diet Tracker : diet

Tracks our daily calories intake. Add food, then calculate

3.2.1. Dieting Mode mode

Allows users to decide which dieting mode they want, based on the following modes:

  • Lose Weight (-l)

  • Gain Weight (-g)

  • Maintain (-m)

Format: diet mode [-m] [-l] [-g]
Example: diet mode -m

3.2.2. Store Height height

Allows user to input their height.

Format: height HEIGHT
Example: height 172

ℹ️
 Height in centimetres (cm), rounded to nearest centimetre

3.2.3. Store Weight weight

Allows user to input their weight.

Format: weight WEIGHT
Example: weight 65.7

ℹ️
 Weight in kilograms (kg), rounded to nearest kilogram

3.2.4. Add food add

Adds food to the list.

Format: add food CALORIES
Example: add Fishball Noodles 383

3.2.5. List items list

List all the items in your current diet tracker. Show different data based on flags.

  • List all food and data in tabular format (-l)

  • Food consumed for the day (-g)

  • Track calories over past number of days (-m)

ℹ️
 Default value of list is food consumed for the day. Default number of days for track calories is past week

Format: list [-f] [-d] [-t [numDays]]
Example: list -t 3

3.2.6. Delete Food Item delete

Deletes a Food item from the list of foods stored.
Format: delete INDEX

  • Deletes the food item at the specified INDEX.

  • The index refers to the index number shown in the displayed food list.

  • The index must be a positive integer 1, 2, 3, …​

💡
 Use list to view your item indices before deletion.

Example:

  • list
    delete 2
    Deletes the 2nd row of food data from the past 7 days of food.

3.2.7. Editing a Food Item edit

Allows you to edit either the Food name, or the calories.
Format: edit INDEX [-n NAME] [-c CALORIES]

  • Edits the Food Item at the specified INDEX. The index refers to the index number shown in the displayed Food list. The index must be a positive integer 1, 2, 3, …​

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

Example:

  • edit 2 -n Chicken Rice -c 585
    Edits the name of the food item at index 2 to be 'Chicken Rice' and the calories to be '585'.

3.2.8. Calculate Daily Calories calc

Calculates and lists the following:

  • Total Calorie Intake for the day.

  • Calories left based on your preferred dieting mode.

Format: calc

3.2.9. Calculate Body Mass Index (BMI) bmi

Allows the user to calculate their BMI based on the height and weight stored in the program.
It will display the following data:

  • Height

  • Weight

  • BMI value

  • BMI category

Format: bmi [-w WEIGHT] [-h HEIGHT]

  • Deletes the person at the specified INDEX.

  • The index refers to the index number shown in the displayed person list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • height 172
    weight 65
    bmi
    Change your height and your weight to your current measurements before calculating your BMI. BMI is calculated based off the stored height and weight in this instance.

  • bmi 65 172
    Calculate BMI based on the input height and weight values.

3.3. Expense Splitter : split

Splitting the food cost with friends. Add person and item, then calculate.

3.3.1. Add person person

Add new person to the list of people involved in the splitting.

Format:
addperson -n NAME [-r ROOM] [-t TELEGRAM] [-p PHONE]
Example:
addperson -n john -r D411 -t @john -p 91234567
addperson -daniel

3.3.2. Add food addfood

Add food and the person involved in the splitting.

Format:
addfood -f FOOD -c COST -n ALL
addfood -f FOOD -c COST -n NAME [-n NAME]…​
Example:
addfood -f pizza -c 30 -n all
addfood -f pasta -c 6 -n john -n bob -n daniel

3.3.3. Calculate cost calculate

Calculate the total cost for each person or display cost owed for a particular person.

Format:
calculate [-n NAME]. . .

Example:
calculate
calculate -n john
calculate -n john -alice

3.3.4. List food(s) items listfood

Display the food(s) in a list:

Format:
listfood

Example:
listfood

3.3.5. List person(s) listperson

Display the person(s) in the list
Format:
listperson

Example:
listperson

3.3.6. Remove person(s) removeperson

Remove person(s) from the list of persons.
Format:
removeperson -n NAME [-n NAME]…​

Example:
removeperson -n john
removeperson -n john -n bob

3.3.7. Remove food(s) removefood

Remove food(s) from the list of foods.
Format:
removefood -f FOOD [-f FOOD]…​

Example:
removefood -f fries
removefood -f pizza -f pasta

3.3.8. Exiting the program exit

Exits the program.
Format:
exit

3.3.9. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

4. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.

5. Command Summary

  • Remove food removefood -f FOOD
    e.g. removefood -f fries

  • Help : help