[Ba]king [Br]ead User Guide

Welcome new bakers! If you're feeling overwhelmed by the chaos of baking, fret not because [Ba]king [Br]ead is here to save the day! We're here to help you manage the overwhelming number of ingredients in your kitchen and the endless recipes you have stored, making your baking experience a lot smoother!

[Ba]king [Br]ead will help you to:

1. Keep track of all your baking ingredients in your kitchen
2. Collate all your recipes digitally for easy viewing
3. Achieve maximum efficiency

Our application's command-line interface, coupled with your fast fingers, makes baking a whole lot more seamless and relaxing!

Long gone are the days when you have to rummage through your cupboards to see what you have. Now with [Ba]king [Br]ead, you will never forget what ingredient you need to stock up on during your next trip to the supermarket. And now, you will never have to flip through endless heavy physical recipe books just to find a recipe you like.

So, what are you waiting for? Master [Ba]king [Br]ead and fast-track your baking journey now!

Using this Guide

This user guide contains all the information you will need in order to use [Ba]king [Br]ead. For new users, this document will also guide you in using the application, starting with the more essential features.

For new users:

• Start using [Ba]king [Br]ead by heading over to the Quick Start to learn how to set up the app and use it.

For experienced users:

• Utilise the Table of Contents to refresh your memory on the various features

Listed below are the definitions of the terminology used throughout the User Guide

Do also take note of the following highlighted information panels as we will be using this throughout the User Guide.

Table of Contents

• Getting Started
• Navigating the GUI
• Features
  • Help
  • Add ingredient
  • Use ingredient
  • Find quantity of ingredient
  • Clear ingredient list
  • View list of all recipes
  • View a recipe
  • Add a recipe
  • Modify a recipe
  • Search for recipes that have an ingredient
  • Exit the program
  • Save the data
  • Edit the data file
• Common Errors
• FAQ
• Command Summary

Quick start

New to [Ba]king [Br]ead? Not to worry, simply follow the instructions below to get started!

Setting up [Ba]king [Br]ead

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

2. Download the latest bakingbread.jar from here.

3. Copy the file to the folder you want to use as the home folder for [Ba]king [Br]ead.

4. Double-click on the jar and a GUI similar to the one below should appear in a few seconds. If this does not work for you, check the FAQ

5. Some sample data has been preloaded into the application

Navigating the GUI

The GUI may be confusing if you are a first time user of our application. Here is the breakdown of the GUI for [Ba]king [Br]ead.
Input box: This is where you will be inputting your commands.
Command result box: Where the application will return a message regarding the outcome of command inputted.
Ingredients list: Contain a list view of all your ingredients with their specified quantity and unit.
Recipe list: Contains a list view of all your recipes.

Tutorials

Adding your first ingredient

Time to add your first ingredient! Take any ingredient from your kitchen, weigh the quantity of that ingredient and let's get started!

1. Suppose that you want to record 100 grams of flour. Type in the command into the application's input box as shown below.
   
   
   
   
2. Press enter to execute the command.
3. You should see the ingredient added into your ingredient list as seen below. Hooray! You have added your first ingredient!
   
   

Adding your first recipe

Recipe adding is a little more complicated! But don't worry, you will get the hang of it in no time! Refer to the infographic below for step-by-step instructions on adding your first recipe.

And there you have it, your first recipe added to [Ba]king [Br]ead!

Features

List of parameter types:

Supported Units:

Viewing help : help

If you are not sure how to use [Ba]king [Br]ead, this command will show a pop-up with a link to access the help page.

Format: help

Adding an ingredient: add

Adds an ingredient to the stock.

Format: add n/NAME q/QUANTITY u/UNIT

• If there is some of the specified ingredient already in the stock, using this command will combine the newly added quantity with the existing quantity.

Restrictions:

• Unit specified must be supported.
• Quantity must be a positive number.
• When adding an ingredient that is already in the stock, the unit conversion must be possible. For example, if the unit of the ingredient which is already in the stock is in GRAM/KILOGRAM, you cannot add the same ingredient in terms of PIECE.
  For example, if the ingredient in the stock is 100 grams of Flour, add n/flour q/50 u/PIECE would throw an error.

Examples:

• add n/Flour q/1 u/kg adds 1kg of Flour to the stock.
• add n/Milk q/600 u/g adds 600g of Milk to the stock.

Example Used: add n/Flour q/1 u/kg Note: Sample started with 3kg of Flour in the stock.

Example Used: add n/Milk q/600 u/g Note: Sample did not have any Milk in the stock.

Using up ingredients : use

Depletes a specified quantity of an ingredient from the stock.

Format: use n/NAME [q/QUANTITY] [u/UNIT]

• If no quantity and unit is specified, the entire stock of the specified ingredient will be depleted.
• If the quantity depleted exceeds the current quantity in stock, the entire stock will be depleted but will not go into the negative.
• Note that the specified name must be exact. As such, use n/butters will not work if the ingredient list contains butter.

Restrictions:

• Unit specified must be supported.
• The quantity provided must be more than 0.
• When specifying the quantity, the unit conversion must be possible. If the unit of the ingredient that is in the stock is in GRAM/KILOGRAM, the use command cannot specify PIECE for using that specific ingredient, and vice versa. For example, if the ingredient in the stock is 100g of Flour, use n/flour q/50 u/PIECE would throw an error.
• When using up an ingredient, an error will be shown if the user inputs only the quantity or only the unit. Either both the unit and quantity must be specified, or neither.

Examples:

• use n/Milk q/600 u/g Depletes the current quantity of milk by 600g.
• use n/Egg Fully depletes the current quantity of egg.

Example Used: use n/Milk q/600 u/g Note: Sample started with 1kg of Milk in the stock.

Finding the quantity of an ingredient by name: stock

Filters the list of ingredients to only the specified ingredient(s).

Format: stock [NAME]…​

• Multiple ingredients can be specified e.g. stock Flour Butter will list the quantities of both ingredients.
• If no ingredients are specified, the quantity of all ingredients will be listed.
• Only full words will be matched e.g. Flou will not match Flour.
• For ingredients with names comprising multiple words, any ingredient that contains the specified word will also be listed.
  e.g. stock butter will display both butter and butter stick.
• When no names are specified, all ingredients will be displayed.

Examples:

• stock Butter will show the Butter ingredient in the list.
• stock Butter flour will show both the Butter and Flour ingredient in the list.
• stock lists all ingredients.
  

Example used: stock butter

Clearing all ingredients from ingredient stock : clear

Clears all ingredients from the ingredient stock.

Format: clear

Example used: clear

Listing all Recipes : list

Lists all recipes that are currently stored in [Ba]king [Br]ead.

Format: list

Example Used: list

Viewing Specific Recipes : view

Views a specific recipe in [Ba]king [Br]ead.

Format: view UUID

• UUID must be an integer greater than or equal to 1.
• To toggle back to listing all recipes, use the list command.

Examples:

• view 1 views the recipe with UUID of 1.
• view 21 views the recipe with UUID of 21.

Example Used: view 1

Adding Recipes : addrecipe

Adds a new recipe to the recipe book. Each line in this command should be entered one by one.

Format:

addrecipe 
NAME
(INGREDIENT_NAME) (INGREDIENT_QUANTITY)(INGREDIENT_UNIT)
⋮
steps start
1. STEP 1
2. STEP 2
⋮
complete recipe

• Name of Recipe needs to be of Alphanumeric format.
• Ingredients specified must be of the format (NAME) (QUANTITY)(UNIT), such as flour 100g.
• The quantity of the ingredient must be positive and the unit must be supported.
• For the recipe steps, the format to follow is (STEP_NUMBER). (STEP) such as 1. Mix Water and Flour.
• For the recipe steps, you should input the appropriate step number at each step, or the order of the steps may be incorrect in the completed recipe.

Example:

addrecipe
Bread
Water 100g
Flour 1kg
steps start
1. Mix Water and Flour
2. Bake at 180C
complete recipe

Modifying Recipes : modify

Modifies the ingredients in a recipe.

Format: modify i/UUID n/NAME q/QUANTITY u/UNIT

• UUID must be an integer greater than or equal to 1.
• The quantity provided must be more than 0.
• The unit used must be supported.

Example:

• Assuming flour is used in the recipe, modify i/1 n/Flour q/100 u/g modifies the Flour ingredient in the recipe to 100 grams of flour.
• Assuming flour is not used in the recipe, modify i/1 n/Flour q/100 u/g adds the 100 grams of the Flour ingredient to the recipe.

Example Used: modify i/1 n/Flour q/100 u/g

Note: Recipe being modified has 200g of flour as part of the ingredient list

Example Used: modify i/1 n/Cream q/100 u/g Note: Recipe being modified does not have cream in its ingredient list

Deleting Recipes : delete

Deletes a specific recipe from [Ba]king [Br]ead when you longer need it.

Format: delete UUID

• UUID must be an integer greater than or equal to 1.
• UUID should match one of the UUIDs of the existing recipes.

Examples:

• delete 1 deletes the recipe with UUID of 1.
• delete 21 deletes the recipe with UUID of 21.

Searching Recipes given an ingredient: search

Searches for recipes that include a specific ingredient.

Format: search NAME

• NAME cannot be empty.
• NAME is case-insensitive.
• If none of the recipes contain that ingredient, an empty recipe list will be displayed instead.
• For ingredients with multiple words, NAME must be an exact match. As such, search chocolate will not display recipes that contain chocolate chips.

Examples:

• search flour searches for all recipes that use flour
• search butter searches for all recipes that use butter

Example used: search flour Note: Multiple recipes use the ingredient flour

Example used: search blueberry Note: Only one recipe uses the ingredient blueberry

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

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

Editing the data file

Inventory data are saved automatically as a JSON file [JAR file location]/data/inventory.json. Advanced users are welcome to update data directly by editing that data file.

Common Possible Errors

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 [Ba]king [Br]ead home folder.

Q: The application does not run when I double-click it!
A: First, check if you have Java 11 installed in your computer. If you do and still have issues, try this: Open a command terminal, cd into the folder you put the jar file in, and use the java -jar bakingbread.jar command to run the application.

Command summary

Note: For AddRecipe, each command is to be run line by line.